Bulk LSP Service Orders and Services Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director Bulk LSP Service Orders and Services Management RESTful Web Services.
Get All Bulk LSP Service Orders
This request is used to retrieve all the configured Bulk LSP service orders.
URI | api/space/nsas/bulk-lsp/service-management/service-orders |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects all the configured Bulk 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> <Common> <Name>Test_SO_BFD</Name> <Identity>262362</Identity> <State>Completed</State> <CreatedDate>2013-12-05T15:38:18.000+05:30</CreatedDate> <LastUpdatedDate>2013-12-05T15:38:34.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>LSP</ServiceType> <OrderType>Provisioning</OrderType> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <Reference> <ServiceDefinition> <ServiceDefinitionID key="262336" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/262336" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/262336" /> </ServiceDefinition> <Service key="262369" href="/api/space/nsas/bulk-lsp/service-management/services/262369" uri="/api/space/nsas/bulk-lsp/service-management/services/262369" /> </Reference> </ServiceOrder> <ServiceOrder href="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" uri="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" key="262258"> <Common> <Name>RSVP_LSP_SO_P2MP_modify_2013-12-05 11:36:21.721</Name> <Identity>262258</Identity> <State>Completed</State> <CreatedDate>2013-12-05T11:37:48.000+05:30</CreatedDate> <LastUpdatedDate>2013-12-05T15:16:08.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>LSP</ServiceType> <OrderType>Modification</OrderType> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <Reference> <ServiceDefinition> <ServiceDefinitionID key="65558" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" /> </ServiceDefinition> <Service key="262193" href="/api/space/nsas/bulk-lsp/service-management/services/262193" uri="/api/space/nsas/bulk-lsp/service-management/services/262193" /> </Reference> </ServiceOrder> </ServiceResource> </Data>
Get a Bulk LSP Service Order By Order ID
This request is used to retrieve the details of a particular Bulk LSP service order based on the service order ID.
URI | api/space/nsas/bulk-lsp/service-management/service-orders/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific Bulk 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 href="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" uri="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" key="262258"> <Common> <Name>RSVP_LSP_SO_P2MP</Name> <Identity>262258</Identity> <State>Completed</State> <CreatedDate>2013-12-05T11:37:48.000+05:30</CreatedDate> <LastUpdatedDate>2013-12-05T15:16:08.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>LSP</ServiceType> <OrderType>Modification</OrderType> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <CommonLSPSettings> <LSPProtectionType>No Protection</LSPProtectionType> <LocalProtectionType>N/A</LocalProtectionType> <RetryLimit>0</RetryLimit> <RetryTimer>30</RetryTimer> <LDPTunneling>false</LDPTunneling> <EnableFastReroute>false</EnableFastReroute> <Standby>false</Standby> <Adaptive>false</Adaptive> <AutoBandwidth>false</AutoBandwidth> <AdjustInterval>0</AdjustInterval> <MinimumBandwidth>0</MinimumBandwidth> <MaximumBandwidth>0</MaximumBandwidth> <Bandwidth>0</Bandwidth> <AdminGroups /> </CommonLSPSettings> <BFD>true</BFD> <BFDSettings> <BFDdetection>This LSP</BFDdetection> <MinInterval>300</MinInterval> <MinReceiveInterval>50</MinReceiveInterval> <Multiplier>3</Multiplier> <NoAdaption>true</NoAdaption> <TransmitMinInterval>50</TransmitMinInterval> <TransmitThreshold>0</TransmitThreshold> <DetectionThreshold>0</DetectionThreshold> <FailureAction>Teardown</FailureAction> </BFDSettings> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>exora</DeviceName> <DeviceID>164532</DeviceID> </Source> <Destination> <DeviceName>junos-mx480-space</DeviceName> <DeviceID>164194</DeviceID> </Destination> <LSPName>RSVP_LSP_SO_P2MP_to_30_1_2_6</LSPName> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterOrderType"> <PrimaryPath> <PathName>Test_Path</PathName> <SetupPriority>7</SetupPriority> <Adaptive>Disabled</Adaptive> <HoldPriority>0</HoldPriority> <ClassOfService>0</ClassOfService> <HopLimit>255</HopLimit> <BandWidth>0</BandWidth> <AdminGroups /> </PrimaryPath> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <Reference> <ServiceDefinition> <ServiceDefinitionID key="65558" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" /> </ServiceDefinition> <Service key="262193" href="/api/space/nsas/bulk-lsp/service-management/services/262193" uri="/api/space/nsas/bulk-lsp/service-management/services/262193" /> </Reference> </ServiceOrder> </ServiceResource> </Data>
Create a Bulk LSP Service Order
This request is used to create a bulk LSP service order.
URI | api/space/nsas/bulk-lsp/service-management/service-orders/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates a bulk LSP service order. |
Input
Sample XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>Test-Bulk-SO-000-1</Name> <Comments>Test-SO-000-1</Comments> </Common> <ServiceTag>Sample_Tag (public)</ServiceTag> <BiDirectional>true</BiDirectional> <CommonLSPSettings> <Bandwidth>0</Bandwidth> <LDPTunneling>true</LDPTunneling> </CommonLSPSettings> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>embassy</DeviceName> <DeviceID>65596</DeviceID> </Source> <Destination> <DeviceName>exora</DeviceName> <DeviceID>65597</DeviceID> </Destination> </TA> </DeviceInfo> </ServiceEndPointGroup> <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>
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceOrder</Type> <Value>6553609</Value> </Identity> <Job> <ID>1998898</ID> <Status>INPROGRESS</Status> </Job> <Code>200</Code> <Message>Service Order Created Successfully and Deployment is in Progress. Please check the status using the JOB ID.</Message> </Status> </Data>
For the various options in creating Service Order the options must be specified in the TA Element inside DeviceInfo.
The possible values are:
DeviceName (Create Service Order with device name)
<Destination> <DeviceName>exora</DeviceName> <DeviceID>65597</DeviceID> </Destination>
EgressTag (Create Service Order with EgressTag)
<Destination> <EgressTag>Test_Tag</EgressTag> </Destination>
Create a Bulk LSP Service Order with LSP Patterns
This request is used to create a bulk LSP service order with support for LSP patterns.
URI | api/space/nsas/bulk-lsp/service-management/service-orders/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates a bulk LSP service order. |
Input
Sample XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>Test-Bulk-SO-000-12334561122</Name> <Comments>Test-SO-000-1</Comments> </Common> <BiDirectional>true</BiDirectional> <CommonLSPSettings> <Bandwidth>0</Bandwidth> <LDPTunneling>true</LDPTunneling> </CommonLSPSettings> <LSPPattern key="134" uri="/api/space/nsas/lsp-pattern/service-management/service-patterns/134" href="/api/space/nsas/lsp-pattern/service-management/service-patterns/134"> <PatternTemplate>$Name_to_$EgressLoopbackAddress</PatternTemplate> </LSPPattern> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>fortius-f1100-a</DeviceName> <DeviceID>98316</DeviceID> </Source> <Destination> <DeviceName>fortius-f2100-a</DeviceName> <DeviceID>98368</DeviceID> </Destination> </TA> </DeviceInfo> </ServiceEndPointGroup> <Reference> <ServiceDefinition> <ServiceDefinitionID key="35"/> </ServiceDefinition> </Reference> </ServiceOrder> </ServiceResource> <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType"> <Action>SaveAndDeployNow</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>ServiceOrder</Type> <Value>163920</Value> </Identity> <Job> <ID>753815</ID> <Status>INPROGRESS</Status> </Job> <Code>200</Code> <Message>Service Order Created Successfully and Deployment has been Scheduled. Please check the status using the JOB ID.</Message> </Status> </Data>
Get a Bulk LSP Service By Service ID
This request is used to retrieve the details of a particular Bulk LSP service.
URI | api/space/nsas/bulk-lsp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management.services+xml |
Produces | Collects the details of a specific Bulk 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/bulk-lsp/service-management/services/262193" uri="/api/space/nsas/bulk-lsp/service-management/services/262193" key="262193"> <Common> <Name>RSVP_LSP_SO_P2MP</Name> <Identity>262193</Identity> <State>Deployed</State> <CreatedDate>2013-12-05T10:40:06.000+05:30</CreatedDate> <LastUpdatedDate>2013-12-05T15:16:08.000+05:30</LastUpdatedDate> </Common> <ServiceType>LSP</ServiceType> <FAStatus>Pending</FAStatus> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <CommonLSPSettings> <LSPProtectionType>No Protection</LSPProtectionType> <LocalProtectionType>N/A</LocalProtectionType> <RetryLimit>0</RetryLimit> <RetryTimer>30</RetryTimer> <LDPTunneling>false</LDPTunneling> <EnableFastReroute>false</EnableFastReroute> <Standby>false</Standby> <Adaptive>false</Adaptive> <AutoBandwidth>false</AutoBandwidth> <AdjustInterval>0</AdjustInterval> <MinimumBandwidth>0</MinimumBandwidth> <MaximumBandwidth>0</MaximumBandwidth> <Bandwidth>0</Bandwidth> <AdminGroups /> </CommonLSPSettings> <BFD>true</BFD> <BFDSettings> <BFDdetection>This LSP</BFDdetection> <MinInterval>300</MinInterval> <MinReceiveInterval>50</MinReceiveInterval> <Multiplier>3</Multiplier> <NoAdaption>true</NoAdaption> <TransmitMinInterval>50</TransmitMinInterval> <TransmitThreshold>0</TransmitThreshold> <DetectionThreshold>0</DetectionThreshold> <FailureAction>Teardown</FailureAction> </BFDSettings> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>exora</DeviceName> <DeviceID>164532</DeviceID> </Source> <Destination> <DeviceName>junos-mx480-space</DeviceName> <DeviceID>164194</DeviceID> </Destination> <LSPName>RSVP_LSP_SO_P2MP_to_30_1_2_6</LSPName> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterServiceType"> <PrimaryPath> <PathName>Test_Path</PathName> <SetupPriority>7</SetupPriority> <Adaptive>Disabled</Adaptive> <HoldPriority>0</HoldPriority> <ClassOfService>0</ClassOfService> <HopLimit>255</HopLimit> <BandWidth>0</BandWidth> <AdminGroups /> </PrimaryPath> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <Reference> <ServiceOrder key="262258" href="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" uri="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" /> <ServiceDefinition> <ServiceDefinitionID key="65558" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" /> </ServiceDefinition> </Reference> </Service> </ServiceResource> </Data>
Get All Bulk LSP Services
This request is used to retrieve all the configured Bulk LSP services.
URI | api/space/nsas/bulk-lsp/service-management/services |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management.servicesxml |
Produces | Collects all the configured Bulk 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="2"> <Service href="/api/space/nsas/bulk-lsp/service-management/services/196617" uri="/api/space/nsas/bulk-lsp/service-management/services/196617" key="196617"> <Common> <Name>Bulk_LSP_SO</Name> <Identity>196617</Identity> <State>Deployed</State> <Comments>Bulk_LSP_SO</Comments> <CreatedDate>2013-11-28T15:50:47.000+05:30</CreatedDate> <LastUpdatedDate>2013-11-28T15:50:47.000+05:30</LastUpdatedDate> </Common> <ServiceType>LSP</ServiceType> <FAStatus>Pending</FAStatus> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <Reference> <ServiceOrder key="196608" href="/api/space/nsas/bulk-lsp/service-management/service-orders/196608" uri="/api/space/nsas/bulk-lsp/service-management/service-orders/196608" /> <ServiceDefinition> <ServiceDefinitionID key="65536" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65536" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65536" /> </ServiceDefinition> </Reference> </Service> <Service href="/api/space/nsas/bulk-lsp/service-management/services/262193" uri="/api/space/nsas/bulk-lsp/service-management/services/262193" key="262193"> <Common> <Name>RSVP_LSP_SO_P2MP</Name> <Identity>262193</Identity> <State>Deployed</State> <Comments>RSVP_LSP_SO_P2MP</Comments> <CreatedDate>2013-12-05T10:40:06.000+05:30</CreatedDate> <LastUpdatedDate>2013-12-05T15:16:08.000+05:30</LastUpdatedDate> </Common> <ServiceType>LSP</ServiceType> <FAStatus>Pending</FAStatus> <BiDirectional>false</BiDirectional> <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> </LSPPattern> <Reference> <ServiceOrder key="262258" href="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" uri="/api/space/nsas/bulk-lsp/service-management/service-orders/262258" /> <ServiceDefinition> <ServiceDefinitionID key="65558" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/65558" /> </ServiceDefinition> </Reference> </Service> </ServiceResource> </Data>