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

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

    Get All Static LSP Service Definitions

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

    URI

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

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects all the configured Static LSP service definitions.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource size="7">
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/229"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/229"
    			key="229">
    			<Common>
    				<Name>Bypass_SD</Name>
    				<Identity>229</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T19:55:56.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Bypass</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/118"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/118"
    			key="118">
    			<Common>
    				<Name>Bypass_test</Name>
    				<Identity>118</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T15:22:34.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Bypass</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/220"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/220"
    			key="220">
    			<Common>
    				<Name>Single_Hop</Name>
    				<Identity>220</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T19:55:04.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - One hop</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/7"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/7"
    			key="7">
    			<Common>
    				<Name>Static LSP Multi-Hop</Name>
    				<Identity>7</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T14:31:32.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Multiple hop</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/15"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/15"
    			key="15">
    			<Common>
    				<Name>Static LSP Multi-Hop with Node Link Protection</Name>
    				<Identity>15</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T14:31:32.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Multiple hop</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/1"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/1"
    			key="1">
    			<Common>
    				<Name>Static LSP-One-Hop</Name>
    				<Identity>1</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T14:31:32.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - One hop</ServiceType>
    		</ServiceDefinition>
    		<ServiceDefinition
    			href="/api/space/nsas/static-lsp/service-management/service-definitions/109"
    			uri="/api/space/nsas/static-lsp/service-management/service-definitions/109"
    			key="109">
    			<Common>
    				<Name>Test</Name>
    				<Identity>109</Identity>
    				<State>Published</State>
    				<CreatedDate>2013-10-18T15:08:16.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Multiple hop</ServiceType>
    		</ServiceDefinition>
    	</ServiceResource>
    </Data>
    
    
    
    

    Get Static LSP Service Definition Details By Definition ID

    This request is used to retrieve the details of a particular Layer 2 Ethernet LAN VPLS BGP service definition, based on the service definition ID.

    URI

    api/space/nsas/static-lsp/service-management/service-definitions/
    <servicedefinition-Id>

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects the details of a specific Static LSP service definition.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceDefinition>
    			<Common>
    				<Name>Static LSP Multi-Hop</Name>
    				<Identity>7</Identity>
    				<State>Published</State>
    				<Comments>Static LSP with multiple hops</Comments>
    				<CreatedDate>2013-08-14T17:56:08.000+05:30</CreatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>Static - Multiple hop</ServiceType>
    			<TA>
    				<LSPProtectionType>No Protection</LSPProtectionType>
    				<LocalProtectionType>N/A</LocalProtectionType>
    				<ServiceTemplate>None</ServiceTemplate>
    				<Advanced>
    					<ClassofService Editable="true">-1</ClassofService>
    					<FastReroute Editable="true">0</FastReroute>
    					<Standby Editable="true">0</Standby>
    				</Advanced>
    				<Protection>
    					<LocalProtection>false</LocalProtection>
    				</Protection>
    			</TA>
    		</ServiceDefinition>
    	</ServiceResource>
    </Data>
    
    
    

    Create a Static LSP Service Definition

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

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    Produces

    Creates a Static LSP service definition.

    Input (Single-Hop Static LSP)

    Sample XML Input

        <Data xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceResource>
        <ServiceDefinition>
        <Common>
        <Name>Static_LSP_singlehop_Test_Via_API</Name>
         <Comments>erwerew</Comments>
        </Common>
        <ServiceType>Static - One hop</ServiceType>
    <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPServiceEndpointGroupParameterDefType"/>
    <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPEndPointParameterDefType"/>
        <TA>
        <LSPProtectionType>No Protection</LSPProtectionType>
        <LocalProtectionType>N/A</LocalProtectionType>
        <ServiceTemplate>None</ServiceTemplate>
        <LabelAllocation>Auto pick</LabelAllocation>
        <Advanced>
        <ClassofService Editable="true">1</ClassofService>
        <Metric Editable="true">1</Metric>
        <Preference Editable="true">5</Preference>
        </Advanced>
        </TA>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    	        <Action>Publish</Action>
        </CustomAction>
      </ServiceDefinition>
        </ServiceResource>
        </Data>
       
    

    Input (Multi-Hop Static LSP)

    Sample XML Input

        <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
        <ServiceDefinition>
        <Common>
        <Name>With_Link_NOde_API</Name>
        </Common>
        <ServiceType>Static - Multiple hop</ServiceType>
    <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPServiceEndpointGroupParameterDefType"/>
    <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPEndPointParameterDefType"/>
        <TA>
        <LSPProtectionType>Local Protection Only</LSPProtectionType>
        <LocalProtectionType>Node-Link protection</LocalProtectionType>
        <ServiceTemplate>None</ServiceTemplate>
        <LabelAllocation>Auto pick</LabelAllocation>
        <PopatpanultimateRouter>true</PopatpanultimateRouter>
        <PopategressRouter>false</PopategressRouter>
        <Advanced>
        <ClassofService Editable="false">N/A</ClassofService>
        <Metric Editable="false">1</Metric>
        <Preference Editable="false">5</Preference>
        </Advanced>
        </TA>
        </ServiceDefinition>
        </ServiceResource>
        </Data>
      
       
    

    Input (Bypass Static LSP)

    Sample XML Input

            <Data xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceResource>
        <ServiceDefinition>
        <Common>
        <Name>StaticLSP_Bypass_Test_Api</Name>
         <Comments>ertrtrr</Comments>
         </Common>
        <ServiceType>Static - Bypass</ServiceType>
    <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPServiceEndpointGroupParameterDefType"/>
    <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="PTPEndPointParameterDefType"/>
        <TA>
        <LSPProtectionType>No Protection</LSPProtectionType>
        <LocalProtectionType>N/A</LocalProtectionType>
        <ServiceTemplate>None</ServiceTemplate>
        <LabelAllocation>Auto pick</LabelAllocation>
        <PopatpanultimateRouter>true</PopatpanultimateRouter>
        <PopategressRouter>false</PopategressRouter>
        </TA>
        <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    	        <Action>Publish</Action>
        </CustomAction>
        </ServiceDefinition>
        </ServiceResource>
        </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>ServiceDefinition</Type>
        <Value>214</Value>
        </Identity>
        <Code>200</Code>
        <Message>ServiceDefinition Created and Published Successfully</Message>
        </Status>
        </Data>
    
    	
    	
    
    

    Publish and Unpublish a Static LSP Service Definition

    This request is used to publish or unpublish a Static LSP service definition.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    Action types are Publish and Unpublish.

    Produces

    Publishes or unpublishes a Static LSP service definition.

    Input for Unpublishing a Service Definition

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">	
    	<CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    		<Action>UnPublish</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>ServiceDefinition</Type>
    			<Value>7012365</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>ServiceDefinition UnPublished Successfully</Message>
    	</Status>
    </Data>
     
    

    Input for Publishing a Service Definition

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">	
    	<CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    		<Action>Publish</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>ServiceDefinition</Type>
    			<Value>7012365</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>ServiceDefinition Published Successfully</Message>
    	</Status>
    </Data>
     
    

    Delete a Static LSP Service Definition

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

    URI

    api/space/nsas/static-lsp/service-management/service-definitions/
    <servicedefinition-id>

    HTTP Method

    DELETE

    Consumes

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

    Produces

    Deletes a Static LSP service definition.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Identity>
    			<Type>ServiceDefinition</Type>
    			<Value>7012365</Value>
    		</Identity>
    		<Code>200</Code>
    		<Message>ServiceDefinition Deleted Successfully</Message>
    	</Status>
    </Data>
     
    

    Modified: 2015-10-13