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 Service Orders Management RESTful Web Services

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

    Get All Static LSP Service Orders

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

    URI

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

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects all the configured Static LSP service orders.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource size="2">
    		
    		<ServiceOrder
    			href="/api/space/nsas/static-lsp/service-management/service-orders/98314"
    			uri="/api/space/nsas/static-lsp/service-management/service-orders/98314"
    			key="98314">
    			<Common>
    				<Name>sdf</Name>
    				<Identity>98314</Identity>
    				<State>Completed</State>
    				<Comments>sfsdf</Comments>
    				<CreatedDate>2013-08-19T11:34:02.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-19T11:34:18.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<Action>Provisioning</Action>
    			<Reference>
    				<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>
    				<Service key="98317"
    					href="/api/space/nsas/static-lsp/service-management/services/98317"
    					uri="/api/space/nsas/static-lsp/service-management/services/98317" />
    			</Reference>
    		</ServiceOrder>
    		<ServiceOrder
    			href="/api/space/nsas/static-lsp/service-management/service-orders/98305"
    			uri="/api/space/nsas/static-lsp/service-management/service-orders/98305"
    			key="98305">
    			<Common>
    				<Name>stsfsd</Name>
    				<Identity>98305</Identity>
    				<State>Completed</State>
    				<Comments>dsfdsf</Comments>
    				<CreatedDate>2013-08-14T19:37:17.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-14T19:37:35.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>LSP</ServiceType>
    			<Action>Provisioning</Action>
    			<Reference>
    				<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>
    				<Service key="98308"
    					href="/api/space/nsas/static-lsp/service-management/services/98308"
    					uri="/api/space/nsas/static-lsp/service-management/services/98308" />
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    </Data>
    
    
    

    Get a Static LSP Service Order By Order ID

    This request is used to retrieve the details of a particular Static LSP service order based on the service order ID.

    URI

    api/space/nsas/static-lsp/service-management/service-orders/
    <serviceOrderId>

    HTTP Method

    GET

    Consumes

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

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

    Produces

    Collects the details of a specific Static LSP service order.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>
    				<Name>Bypass</Name>
    				<Identity>152</Identity>
    				<State>Completed</State>
    				<CreatedDate>2013-11-07T18:53:54.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-11-07T18:54:29.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</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>
    			<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>
    				<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>
    				<Service key="157"
    					href="/api/space/nsas/static-lsp/service-management/services/157"
    					uri="/api/space/nsas/static-lsp/service-management/services/157" />
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    </Data>
    
    
    

    Sample XML Output

    Create a Static LSP Service Order

    This request is used to create a Static LSP service order.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

    • Save (Create and only Save a SO)

    • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

    • SaveAndDeployNow (Create, Save, and Deploy a SO)

    • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

    Produces

    Creates a Static LSP service order.

    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>
    				<Name>S_AP1</Name>				
    			</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.1</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.2, 20.1.46.3 </DestinationAddress>
    			</IngressRouterSetting>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="1"/>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction></Data>
    
    

    Input (Bypass Single-Hop Static LSP with Auto-Pick Label)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>
    				<Name>BY_P_A</Name>				
    			</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.1</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/0.166</NextHopInterface>
    					<NextHopAddress>20.1.46.1</NextHopAddress>
    					<LabelOperation>SWAP</LabelOperation>
    					
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>kochin</DeviceName>
    						<DeviceID>360450</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Transit</RouterType>
    					<NextHopInterface>ge-0/0/7.2</NextHopInterface>
    					<NextHopAddress>20.1.46.1</NextHopAddress>
    					<LabelOperation>POP</LabelOperation>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space3</DeviceName>
    						<DeviceID>360626</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Egress</RouterType>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="98317"/>
    				</ServiceDefinition>
    				
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction>
    </Data>
    
    

    Input (Single-Hop Static LSP with Manual Label)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			<Common>
    				<Name>BY_P_A1</Name>				
    			</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.1</NextHopAddress>
    					<LabelOperation>PUSH</LabelOperation>
    					<Label>1005097</Label>
    				</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.1</NextHopAddress>
    					<LabelOperation>SWAP</LabelOperation>
    					<Label>1001683</Label>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>kochin</DeviceName>
    						<DeviceID>360450</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Transit</RouterType>
    					<NextHopInterface>ge-0/0/7.2</NextHopInterface>
    					<NextHopAddress>20.1.46.1</NextHopAddress>
    					<LabelOperation>POP</LabelOperation>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<TA>
    						<DeviceName>junos-space3</DeviceName>
    						<DeviceID>360626</DeviceID>
    					</TA>
    				</DeviceInfo>
    				<RouterSetting>
    					<RouterType>Egress</RouterType>
    				</RouterSetting>
    			</ServiceEndPointGroup>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="327940"/>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
                      			<Action>SaveAndDeployNow</Action>
                    	        	</CustomAction>
    </Data>
    

    Deploy a Static LSP Service Order

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

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

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

    • DeployNow (Deploy an already created SO)

    • DeployLater (Deploy Later an already created SO)

    • ValidateNow (Validate now an already created SO)

    • ValidateLater (Validate later an already created SO)

    • PartialDeleteNow (Delete the partially created configuration now)

    • PartialDeleteLater (Delete the partially created configuration Later

    Produces

    Deploys a previously created Static LSP service order.

    Input

    Sample XML Input

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

    Validate a Static LSP Service Order

    This request is used to validate a previously created Static LSP service order.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

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

    • DeployNow (Deploy an already created SO)

    • DeployLater (Deploy Later an already created SO)

    • ValidateNow (Validate now an already created SO)

    • ValidateLater (Validate later an already created SO)

    • PartialDeleteNow (Delete the partially created configuration now)

    • PartialDeleteLater (Delete the partially created configuration Later

    Produces

    Validates a previously created Static LSP service order.

    Input

    Sample XML Input

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

    Delete a Static LSP Service Order

    This request is used to delete a previously configured Static LSP service order.

    URI

    api/space/nsas/static-lsp/service-management/service-orders/
    <serviceOrder-id>

    HTTP Method

    DELETE

    Consumes

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

    Produces

    Deletes a Static LSP service order.

    Output

    Sample XML Output

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

    View the Pending Configuration of a Static LSP Service Order

    This request is used to view the details of a Static LSP service order that are pending to be applied to a device.

    URI

    api/space/nsas/static-lsp/service-management/service-orders/
    view-pendingorderconfiguration/<serviceOrder-id>

    HTTP Method

    GET

    Consumes

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

    Produces

    Displays the configuration details of a service order pending to be applied to a device.

    Output

    Sample XML Output

    Modified: 2017-09-13