Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Static LSP Services Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Static LSP Services Management RESTful Web Services.

    Get a Static LSP Service By Service ID

    This request is used to retrieve the details of a particular Static LSP service.

    URI

    api/space/nsas/static-lsp/service-management/
    services/<serviceId>

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.service-management.services+xml

    Produces

    Collects the details of a specific Static LSP service.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<Service href="/api/space/nsas/static-lsp/service-management/services/157"
    			uri="/api/space/nsas/static-lsp/service-management/services/157" key="157">
    			<Common>
    				<Name>Bypass</Name>
    				<Identity>157</Identity>
    				<State>Deployed</State>
    				<CreatedDate>2013-11-07T18:54:29.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-11-07T18:54:29.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<LSPName>Bypass_to_50_1_2_3</LSPName>
    			<LSPPattern key="102"
    				uri="/api/space/nsas/lsp-pattern/service-management/service-patterns/102"
    				href="/api/space/nsas/lsp-pattern/service-management/service-patterns/102">
    				<PatternTemplate>$Name_to_$EgressLoopbackAddress</PatternTemplate>
    				<PatternName>Default LSP Pattern</PatternName>
    				<PatternID>102</PatternID>
    			</LSPPattern>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    				<SLAStatus>None</SLAStatus>
    			</AuditFlag>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA
    						href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65998"
    						uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65998"
    						key="65998">
    						<DeviceName>embassy</DeviceName>
    						<DeviceID>65998</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Ingress</RouterType>
    					<NextHopInterface>ge-1/1/0.15</NextHopInterface>
    					<NextHopAddress>10.5.67.8</NextHopAddress>
    					<LabelOperation>PUSH</LabelOperation>
    					<Label>1000000</Label>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA
    						href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65685"
    						uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65685"
    						key="65685">
    						<DeviceName>junos-mx240-space</DeviceName>
    						<DeviceID>65685</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Transit</RouterType>
    					<NextHopInterface>ge-0/0/4.7</NextHopInterface>
    					<NextHopAddress>10.3.45.6</NextHopAddress>
    					<LabelOperation>POP</LabelOperation>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA
    						href="/api/space/nsas/prestage-ta-device/manage-devices/devices/66063"
    						uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/66063"
    						key="66063">
    						<DeviceName>exora</DeviceName>
    						<DeviceID>66063</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Egress</RouterType>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<Reference>
    				<ServiceOrder key="152"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/152"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/152" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="118"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/118"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/118" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    	</ServiceResource>
    </Data>
    

    Get All Static LSP Services

    This request is used to retrieve all the configured Static LSP services.

    URI

    api/space/nsas/static-lsp/service-management/services

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.service-management.
    servicesxml

    Produces

    Collects all the configured Static LSP services.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource size="5">
    		<Service href="/api/space/nsas/static-lsp/service-management/services/98308"
    			uri="/api/space/nsas/static-lsp/service-management/services/98308" key="98308">
    			<Common>
    				<Name>stsfsd</Name>
    				<Identity>98308</Identity>
    				<State>Deployed</State>
    				<Comments>stsfsd</Comments>
    				<CreatedDate>2013-08-14T19:37:35.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-14T19:37:35.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    			</AuditFlag>
    			<Reference>
    				<ServiceOrder key="98305"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/98305"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/98305" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="1"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/1"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/1" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    		<Service href="/api/space/nsas/static-lsp/service-management/services/98317"
    			uri="/api/space/nsas/static-lsp/service-management/services/98317" key="98317">
    			<Common>
    				<Name>sdf</Name>
    				<Identity>98317</Identity>
    				<State>Deployed</State>
    				<Comments>sdf</Comments>
    				<CreatedDate>2013-08-19T11:34:18.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-19T11:34:18.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    			</AuditFlag>
    			<Reference>
    				<ServiceOrder key="98314"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/98314"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/98314" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="1"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/1"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/1" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    		<Service href="/api/space/nsas/static-lsp/service-management/services/262148"
    			uri="/api/space/nsas/static-lsp/service-management/services/262148"
    			key="262148">
    			<Common>
    				<Name>Teststaticl</Name>
    				<Identity>262148</Identity>
    				<State>Deployed</State>
    				<Comments>Teststaticl</Comments>
    				<CreatedDate>2013-09-06T14:48:34.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-09-06T14:48:34.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    			</AuditFlag>
    			<Reference>
    				<ServiceOrder key="262144"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/262144"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/262144" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="23"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/23"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/23" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    		<Service href="/api/space/nsas/static-lsp/service-management/services/294917"
    			uri="/api/space/nsas/static-lsp/service-management/services/294917"
    			key="294917">
    			<Common>
    				<Name>test_static</Name>
    				<Identity>294917</Identity>
    				<State>Deployed</State>
    				<Comments>test_static</Comments>
    				<CreatedDate>2013-09-12T18:41:14.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-09-12T18:41:14.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    			</AuditFlag>
    			<Reference>
    				<ServiceOrder key="294912"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/294912"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/294912" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="36"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/36"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/36" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    		<Service href="/api/space/nsas/static-lsp/service-management/services/294928"
    			uri="/api/space/nsas/static-lsp/service-management/services/294928"
    			key="294928">
    			<Common>
    				<Name>teststatic</Name>
    				<Identity>294928</Identity>
    				<State>Deployed</State>
    				<Comments>teststatic</Comments>
    				<CreatedDate>2013-09-13T13:49:10.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-09-13T13:49:10.000+05:30</LastUpdatedDate>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<AuditFlag>
    				<FunctionalAudit>Pending</FunctionalAudit>
    				<FaultStatus>None</FaultStatus>
    			</AuditFlag>
    			<Reference>
    				<ServiceOrder key="294925"
    					href="/api/space/nsas/static-lsp/service-management/service-orders/294925"
    					uri="/api/space/nsas/static-lsp/service-management/service-orders/294925" />
    				<ServiceDefinition>
    					<ServiceDefinitionID key="7"
    						href="/api/space/nsas/static-lsp/service-management/service-definitions/7"
    						uri="/api/space/nsas/static-lsp/service-management/service-definitions/7" />
    				</ServiceDefinition>
    			</Reference>
    		</Service>
    	</ServiceResource>
    </Data>
    
    
    

    Modify a Static LSP Service

    This request is used to modify a Static LSP service.

    URI

    api/space/nsas/static-lsp/service-management/
    services/{service-Id}

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.service-
    management.
    modify-service+xml;version=2;charset=UTF-8

    Consumes

    application/vnd.net.juniper.space.service-management.
    service-status+xml;version=2

    Produces

    Modifies a Static LSP service.

    Input (Single-Hop Static LSP)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>							
    			</Common>				
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>360698</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Ingress</RouterType>
    					<NextHopInterface>ge-0/1/6.0</NextHopInterface>
    					<NextHopAddress>20.1.46.10</NextHopAddress>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space3</DeviceName>
    						<DeviceID>360626</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Egress</RouterType>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<IngressRouterSetting>
    				<Advance>
    					<ClassOfService>N/A</ClassOfService>
    					<Metric>4</Metric>
    					<Preference>5</Preference>
    				</Advance>
    				<DestinationAddress>20.1.46.7 MOD 20.1.46.8, 20.1.46.2 RM</DestinationAddress>
    			</IngressRouterSetting>			
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction></Data>
    
    
    

    Input (Single-Hop Static LSP with Addition or Edit of Destination Address)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>							
    			</Common>				
    			<ServiceEndPointGroup>				
    			</ServiceEndPointGroup>			
    			<IngressRouterSetting>				
    				<DestinationAddress>20.1.46.7 MOD 20.1.46.8, 20.1.46.2 RM, 20.1.46.10, 20.1.46.15</DestinationAddress>
    			</IngressRouterSetting>			
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction></Data>
    
    

    Input (Single-Hop Static LSP with Edit of Advanced Settings)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>							
    			</Common>				
    			<ServiceEndPointGroup>				
    			</ServiceEndPointGroup>			
    			<IngressRouterSetting>				
    			<Advance>
    					<ClassOfService>N/A</ClassOfService>
    					<Metric>4</Metric>
    					<Preference>5</Preference>
    				</Advance>	
    			</IngressRouterSetting>			
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction></Data>
    
    
    

    Input (Bypass Static LSP)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>
    
    			</Common>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>360698</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Ingress</RouterType>
    					<NextHopInterface>ge-0/1/6.0</NextHopInterface>
    					<NextHopAddress>20.1.46.21</NextHopAddress>
    					<LabelOperation>PUSH</LabelOperation>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>360533</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Transit</RouterType>
    					<NextHopInterface>ge-0/1/6.3</NextHopInterface>
    					<NextHopAddress>20.1.46.11</NextHopAddress>
    					<LabelOperation>SWAP</LabelOperation>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			
    		</ServiceOrder>
    	</ServiceResource>
    	<CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    		xsi:type="ServiceCustomActionType">
    		<Action>SaveAndDeployNow</Action>
    	</CustomAction>
    </Data>
    
    

    Force-Deploy a Static LSP Service

    This request is used to forcibly deploy a previously created Static LSP service.

    URI

    api/space/nsas/static-lsp/service-management/
    services/{serviceId}

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.service-management.
    modify-service+xml

    Consumes

    application/vnd.net.juniper.space.service-management.
    service-status+xml

    The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:

    • DeployNow

    • DeployLater

    Produces

    Forcibly deploys a previously created Static LSP service.

    Input

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                   <CustomAction xsi:type="ServiceCustomActionType">
                               <Action>DeployNow</Action>
                     </CustomAction>
    </Data>
     
    

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Identity>
    			<Type>Service</Type>
    			<Value>123</Value>
    		</Identity>
    		<Job>
    			<ID>688267</ID>
    			<Status>INPROGRESS</Status>
    		</Job>
    		<Code>200</Code>
    		<Message>Service Force Deploy was Successfully triggered. Please check
    			the status using the JOB ID.</Message>
    	</Status>
    </Data>
    
    

    Decommission a Static LSP Service Immediately

    This request is used to decommission a previously created Static LSP service immediately.

    URI

    api/space/nsas/static-lsp/service-management/
    services/{serviceId}

    HTTP Method

    DELETE

    Content-Type

    application/vnd.net.juniper.space.service-management.service+xml

    Produces

    Decommissions a previously created Static LSP service immediately.

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Identity>
    			<Type>StaticLSPService</Type>
    			<Value>6553600</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>Service service Deleted Successfully.</Message>
    	</Status>
    </Data>
    
    
    

    Decommission a Static LSP Service Later

    This request is used to decommission a previously created Static LSP service at a later time.

    URI

    api/space/nsas/static-lsp/service-management/
    services/{serviceId}

    HTTP Method

    DELETE

    Content-Type

    application/vnd.net.juniper.space.service-management.service+xml

    Produces

    Decommissions a previously created Static LSP service at a later time.

    Input

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <Identity>
                       <Type>Service</Type>
                        <Value>1540110</Value>
             </Identity>
    <CustomAction xsi:type="ServiceCustomActionType">
                    <Action>DecommissionLater</Action>
                   <ScheduledDateTime>2012-04-09T19:07:18.000+05:30</ScheduledDateTime>
    </CustomAction>
    </Data>
    
    

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Identity>
    			<Type>Service</Type>
    			<Value>1179679</Value>
    		</Identity>
    		<Job>
    			<ID>1998906</ID>
    			<Status>INPROGRESS</Status>
    		</Job>
    		<Code>200</Code>
    		<Message>Service Decommission was Successfully triggered. Please check
    			the status using the JOB ID.</Message>
    	</Status>
    </Data> 
    
    

    Modified: 2017-09-13