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

    Paths, Admin Groups, Tags, and LSP Patterns Device Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Paths, Admin Groups, Tags, and LSP Patterns Management RESTful Web Services.

    Get All TA Tags

    This request is used to collect all the TA tags.

    URI

    api/space/nsas/ta/lsp-tags

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.lsp-tags +xml

    Produces

    Retrieves all the TA tags.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd ">
    	<Tags size=�2�>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2564" uri="/api/space/nsas/ta/lsp-tags/2564" key="2564">				<Name>Test_Service</Name>
    			<Identity>2564</Identity>
    			<AccessType>public</AccessType >
    		</Tag>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2565" uri="/api/space/nsas/ta/lsp-tags/2565" key="2565">				<Name>Test_Device</Name>
    			<Identity>2565</Identity>
    			<AccessType>private</AccessType>
    		</Tag>
    </Tags>
    </Data>
    
    
    
    

    Get All TA Device Tags

    This request is used to collect all the TA device tags.

    URI

    api/space/nsas/ta/lsp-tags/devices

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.lsp-tags.devices+xml

    Produces

    Retrieves all the TA device tags.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd ">
    	<Tags size=�2�>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2564" uri="/api/space/nsas/ta/lsp-tags/2564" key="2564">				<Name>Test_Device _000</Name>
    			<Identity>2564</Identity>
    			<AccessType>public</AccessType>
    		</Tag>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2565" uri="/api/space/nsas/ta/lsp-tags/2565" key="2565">					<Name>Test_Device_001</Name>
    			<Identity>2565</Identity>
    			<AccessType>private</AccessType>
    		</Tag>
    </Tags>
    </Data>
    
    
    
    
    

    Get All TA Service Tags

    This request is used to collect all the TA service tags.

    URI

    api/space/nsas/ta/lsp-tags/services

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.lsp-tags.devices+xml

    Produces

    Retrieves all the TA service tags.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd ">
    	<Tags size=�2�>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2564" uri="/api/space/nsas/ta/lsp-tags/2564" key="2564">				<Name>Test_Service_000</Name>
    			<Identity>2564</Identity>
    			<AccessType>public</AccessType>
    		</Tag>
    		<Tag href="/api/space/nsas/ta/lsp-tags/2565" uri="/api/space/nsas/ta/lsp-tags/2565" key="2565">				<Name>Test_Service_001</Name>
    			<Identity>2565</Identity>
    			<AccessType>private</AccessType>
    		</Tag>
    </Tags>
    </Data>
    
    
    
    
    

    Get TA Tags By Tag ID

    This request is used to collect a particular TA tag.

    URI

    api/space/nsas/ta/lsp-tags

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.lsp-tag+xml

    Produces

    Retrieves a particular TA tag.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data>
    	<Tags>
    		<Tag href="/api/space/nsas/ta/lsp-tags/1638602" uri="/api/space/nsas/ta/lsp-tags/1638602"
    			key="1638602">
    			<Name>Test_Service</Name>
    			<Identity>1638602</Identity>
    			<AccessType>private</AccessType>
    		</Tag>
    		<Devices size=�2�>
    			<Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/164194" 
                                                               uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/164194"
                                                                key="164194">
    				<Common>
    					<Name>junos-mx480-space</Name>
    					<Identity>164194</Identity>
    				</Common>
    			</Device>
    			<Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/163977" 
                                                                uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/163977"
                                                                key="163977">
    				<Common>
    					<Name>junos-mx240-space</Name>
    					<Identity>163977</Identity>
    				</Common>
    			</Device>
    		</Devices>
    	</Tags>
    </Data>
    
    
    

    Get RSVP Paths By Device ID

    This request is used to retrieve an RSVP path based on the device ID.

    URI

    api/space/nsas/ta-device-path/manage-devices/
    devices/{device-id}

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.manage-devices.ta-device+xml

    Produces

    Retrieves the RSVP path based on the device ID.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Devices>
    		<Device href="/api/space/nsas/ta-device-path/manage-devices/devices/98626"
    			uri="/api/space/nsas/ta-device-path/manage-devices/devices/98626"
    			key="98626">
    			<Common>
    				<Name>embassy</Name>
    				<Identity>98626</Identity>
    			</Common>
    			<LoopBackAddress>50.1.2.4</LoopBackAddress>
    			<IPAddress>10.216.114.109</IPAddress>
    			<Paths>
    				<Path>
    					<PathName>EmbNoERO1</PathName>
    				</Path>
    				<Path>
    					<PathName>EmbPath1</PathName>
    				</Path>
    				<Path>
    					<PathName>EmbMultiERO1</PathName>
    					<IPAddress>10.1.2.3</IPAddress>
    					<Connection>Strict</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbMultiERO1</PathName>
    					<IPAddress>10.1.2.4</IPAddress>
    					<Connection>Loose</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbMultiERO1</PathName>
    					<IPAddress>10.1.2.5</IPAddress>
    					<Connection>Strict</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbMultiERO1</PathName>
    					<IPAddress>10.1.2.6</IPAddress>
    					<Connection>Loose</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbNoERO2</PathName>
    				</Path>
    				<Path>
    					<PathName>EmbNoERO3</PathName>
    				</Path>
    				<Path>
    					<PathName>EmbPath4</PathName>
    					<IPAddress>1.2.3.4</IPAddress>
    					<Connection>Strict</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbPath4</PathName>
    					<IPAddress>1.2.3.6</IPAddress>
    					<Connection>Strict</Connection>
    				</Path>
    				<Path>
    					<PathName>EmbPath4</PathName>
    					<IPAddress>1.2.3.7</IPAddress>
    					<Connection>Loose</Connection>
    				</Path>
    				<Path>
    					<PathName>primary</PathName>
    				</Path>
    				<Path>
    					<PathName>backup</PathName>
    				</Path>
    				<Path>
    					<PathName>Second</PathName>
    				</Path>
    				<Path>
    					<PathName>primary-2</PathName>
    				</Path>
    				<Path>
    					<PathName>primary1</PathName>
    				</Path>
    				<Path>
    					<PathName>backup1</PathName>
    				</Path>
    				<Path>
    					<PathName>Second1</PathName>
    				</Path>
    				<Path>
    					<PathName>primary2</PathName>
    				</Path>
    				<Path>
    					<PathName>backup2</PathName>
    				</Path>
    				<Path>
    					<PathName>Second2</PathName>
    				</Path>
    				<Path>
    					<PathName>primary5</PathName>
    				</Path>
    				<Path>
    					<PathName>primary6</PathName>
    				</Path>
    				<Path>
    					<PathName>backup6</PathName>
    				</Path>
    				<Path>
    					<PathName>Second6</PathName>
    				</Path>
    				<Path>
    					<PathName>backup5</PathName>
    					<IPAddress>1.2.3.5</IPAddress>
    					<Connection>Loose</Connection>
    				</Path>
    			</Paths>
    		</Device>
    	</Devices>
    </Data>
    
    
    

    Get RSVP Admin Groups By Device ID

    This request is used to retrieve an RSVP admin group based on the device ID.

    URI

    api/space/nsas/prestage-ta-device/manage-devices/
    devices/{device-id}

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.
    manage-devices.ta-device+xml

    Produces

    Retrieves the RSVP admin group based on the device ID.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Devices>
    		<Device
    			href="/api/space/nsas/prestage-ta-device/manage-devices/devices/98626"
    			uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/98626"
    			key="98626">
    			<Common>
    				<Name>embassy</Name>
    				<Identity>98626</Identity>
    			</Common>
    			<LoopBackAddress>50.1.2.4</LoopBackAddress>
    			<Admins>
    				<AdminGroup>
    					<Name>gold</Name>
    					<GroupValue>1</GroupValue>
    				</AdminGroup>
    				<AdminGroup>
    					<Name>silver</Name>
    					<GroupValue>2</GroupValue>
    				</AdminGroup>
    				<AdminGroup>
    					<Name>copper</Name>
    					<GroupValue>3</GroupValue>
    				</AdminGroup>
    			</Admins>
    			<IPAddress>10.216.114.109</IPAddress>
    
    
    
    

    Get LSP Patterns by Pattern ID

    This request is used to collect a particular LSP pattern.

    URI

    /api/space/nsas/lsp-pattern/service-management/
    service-patterns/{id}

    HTTP Method

    GET

    Consumes

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

    Produces

    Retrieves a particular LSP pattern.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServicePattern key="108"
    			uri="/api/space/nsas/lsp-pattern/service-management/service-patterns/108"
    			href="/api/space/nsas/lsp-pattern/service-management/service-patterns/108">
    			<Common>
    				<Name>Full Mesh13</Name>
    				<Identity>108</Identity>
    				<State>Published</State>
    				<CreatedDate>2014-01-10T18:17:53.000+05:30</CreatedDate>
    			</Common>
    			<PatternType>RSVP</PatternType>
    			<StandardPattern>true</StandardPattern>
    			<UniqueCheck>false</UniqueCheck>
    			<PatternTemplate>$Name_$IngressRouter_to_$EgressLoopbackAddress
    			</PatternTemplate>
    			<PatternTemplates>
    				<Patterns>
    					<Position>1</Position>
    					<Template>$Name</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Position>2</Position>
    					<Template>_</Template>
    					<StatndardVariable>false</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Position>3</Position>
    					<Template>$IngressRouter</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Position>4</Position>
    					<Template>_to_</Template>
    					<StatndardVariable>false</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Position>5</Position>
    					<Template>$EgressLoopbackAddress</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    			</PatternTemplates>
    		</ServicePattern>
    	</ServiceResource>
    </Data>
    
    

    Create a New LSP Pattern

    This request is used to create a new LSP pattern.

    URI

    /api/space/nsas/lsp-pattern/service-management/
    service-patterns/

    HTTP Method

    POST

    Content Type

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

    Consumes

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

    Produces

    Creates an LSP pattern.

    Input

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServicePattern>
    			<Common>
    				<Name>Full Mesh13</Name>				
    			</Common>
    			<PatternType>RSVP</PatternType>
    			<StandardPattern>true</StandardPattern>
    			<UniqueCheck>false</UniqueCheck>
    			<PatternTemplate>$Name_$IngressRouter_to_$EgressLoopbackAddress
    			</PatternTemplate>
    			<PatternTemplates>
    				<Patterns>
    					<Template>$Name</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Template>_</Template>
    					<StatndardVariable>false</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Template>$IngressRouter</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Template>_to_</Template>
    					<StatndardVariable>false</StatndardVariable>
    				</Patterns>
    				<Patterns>
    					<Template>$EgressLoopbackAddress</Template>
    					<StatndardVariable>true</StatndardVariable>
    				</Patterns>
    			</PatternTemplates>
    		</ServicePattern>
    	</ServiceResource>
    </Data>
    
    
    

    Get All LSP Pattern Variables

    This request is used to collect all the LSP pattern variables.

    URI

    api/space/nsas/lsp-pattern/service-management/
    service-patterns/{variable-type}/variables

    Variable types are rsvp, general, static

    HTTP Method

    GET

    Consumes

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

    Produces

    Retrieves all the LSP pattern variables.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServicePattern>
    			<PatternType>RSVP</PatternType>
    			<SpecificVariables>
    				<Variable>$Name</Variable>
    				<Variable>$Description</Variable>
    				<Variable>$IngressRouter</Variable>
    				<Variable>$EgressRouter</Variable>
    				<Variable>$TransitRouters</Variable>
    				<Variable>$HoldPriority</Variable>
    				<Variable>$HopLimit</Variable>
    				<Variable>$ClassofService</Variable>
    				<Variable>$Bandwidth</Variable>
    				<Variable>$RetryLimit</Variable>
    				<Variable>$RetryTimer</Variable>
    				<Variable>$TransmitThreshold</Variable>
    				<Variable>$DetectionThreshold</Variable>
    				<Variable>$FailureAction</Variable>
    				<Variable>$TeardownTimeout</Variable>
    				<Variable>$LocalProtectionType</Variable>
    				<Variable>$AdjustInterval</Variable>
    				<Variable>$EgressLoopbackAddress</Variable>
    				<Variable>$LSPDefinition</Variable>
    				<Variable>$PrimaryPathName</Variable>
    				<Variable>$SecondaryPathName</Variable>
    			</SpecificVariables>
    		</ServicePattern>
    	</ServiceResource>
    </Data>
    
    
    

    Modified: 2015-10-13