RSVP LSP Services Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director RSVP LSP Services Management RESTful Web Services.
Get an RSVP LSP Service By Service ID
This request is used to retrieve the details of a particular RSVP LSP service.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific RSVP 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/rsvp-lsp/service-management/service/141" uri="/api/space/nsas/rsvp-lsp/service-management/service/141" key="141"> <Common> <Name>RSVP_BFD_PATH</Name> <Identity>141</Identity> <State>Deployed</State> <CreatedDate>2013-02-08T14:29:08.000+05:30</CreatedDate> <LastUpdatedDate>2013-02-08T14:29:08.000+05:30</LastUpdatedDate> </Common><CreatedFrom>Connectivity</CreatedFrom> <DeployBy>NorthStar</DeployBy> <ServiceType>LSP</ServiceType> <AuditFlag> <FunctionalAudit>Pending</FunctionalAudit> <FaultStatus>None</FaultStatus> </AuditFlag> <ServiceEndPointGroup> <DeviceInfo> <TA> <DeviceName>embassy</DeviceName> <DeviceID>65596</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterServiceType"> <PathName>embassy_path1</PathName> <SetupPriority>7</SetupPriority> <HoldPriority>0</HoldPriority> <ClassOfService>1</ClassOfService> <HopLimit>255</HopLimit> <Adaptive>Enabled</Adaptive> <BandWidth>0</BandWidth> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceEndPointGroup> <DeviceInfo> <TA> <DeviceName>jaipur</DeviceName> <DeviceID>65570</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterServiceType"> <PathName>embassy_path2</PathName> <SetupPriority>7</SetupPriority> <HoldPriority>0</HoldPriority> <ClassOfService>1</ClassOfService> <HopLimit>255</HopLimit> <Adaptive>Enabled</Adaptive> <BandWidth>0</BandWidth> <StandBy>true</StandBy> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceParameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDConfigParameterServiceType"> <RetryLimit>3</RetryLimit> <RetryTimer>30</RetryTimer> <BandWidth>0</BandWidth> <LDPTunneling>Enabled</LDPTunneling> <AutoBandWidth> <AutoBandwidth>true</AutoBandwidth> <AdjustInterval>300</AdjustInterval> <MaxBandwidth>20</MaxBandwidth> <MinBandwidth>10</MinBandwidth> </AutoBandWidth> <ProtectionSetting> <LSPProtectionType>Path Protection</LSPProtectionType> <LocalProtection>N/A</LocalProtection> </ProtectionSetting> <BFD> <BFDdetection>This LSP</BFDdetection> <MinInterval>300</MinInterval> <MinReceiveInterval>50</MinReceiveInterval> <Multiplier>3</Multiplier> <NoAdaption>true</NoAdaption> <TransmitMinInterval>50</TransmitMinInterval> <TransmitThreshold>300</TransmitThreshold> <DetectionThreshold>1000</DetectionThreshold> <FailureAction>Teardown</FailureAction> </BFD> </ServiceParameters> <Reference> <ServiceOrder key="136" href="/api/space/nsas/rsvp-lsp/service-management/service-orders/136" uri="/api/space/nsas/rsvp-lsp/service-management/service-orders/136" /> <ServiceDefinition> <ServiceDefinitionID key="48" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" /> </ServiceDefinition> </Reference> </Service> </ServiceResource> </Data>
Get All RSVP LSP Services
This request is used to retrieve all the configured RSVP LSP services.
URI | api/space/nsas/rsvp-lsp/service-management/services |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects all the configured RSVP 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/rsvp-lsp/service-management/service/123" uri="/api/space/nsas/rsvp-lsp/service-management/service/123" key="123"> <Common> <Name>RSVP_BFD_001</Name> <Identity>123</Identity> <State>Deployed</State> <Comments>RSVP_BFD_001</Comments> <CreatedDate>2013-02-08T12:56:48.000+05:30</CreatedDate> <LastUpdatedDate>2013-02-08T12:56:48.000+05:30</LastUpdatedDate> </Common> <CreatedFrom>Tunnel</CreatedFrom> <DeployBy>NorthStar</DeployBy> <ServiceType>LSP</ServiceType> <AuditFlag> <FunctionalAudit>Pending</FunctionalAudit> <FaultStatus>None</FaultStatus> </AuditFlag> <Reference> <ServiceOrder key="118" href="/api/space/nsas/rsvp-lsp/service-management/service-orders/118" uri="/api/space/nsas/rsvp-lsp/service-management/service-orders/118" /> <ServiceDefinition> <ServiceDefinitionID key="48" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" /> </ServiceDefinition> </Reference> </Service> <Service href="/api/space/nsas/rsvp-lsp/service-management/service/141" uri="/api/space/nsas/rsvp-lsp/service-management/service/141" key="141"> <Common> <Name>RSVP_BFD_PATH</Name> <Identity>141</Identity> <State>Deployed</State> <Comments>RSVP_BFD_PATH</Comments> <CreatedDate>2013-02-08T14:29:08.000+05:30</CreatedDate> <LastUpdatedDate>2013-02-08T14:29:08.000+05:30</LastUpdatedDate> </Common> <ServiceType>LSP</ServiceType> <AuditFlag> <FunctionalAudit>Pending</FunctionalAudit> <FaultStatus>None</FaultStatus> </AuditFlag> <Reference> <ServiceOrder key="136" href="/api/space/nsas/rsvp-lsp/service-management/service-orders/136" uri="/api/space/nsas/rsvp-lsp/service-management/service-orders/136" /> <ServiceDefinition> <ServiceDefinitionID key="48" href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/48" /> </ServiceDefinition> </Reference> </Service> </ServiceResource> </Data>
Modify a Point-to-Point RSVP LSP Service
This request is used to modify an RSVP LSP service.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Modifies an RSVP LSP service. |
Input
Sample XML Input
Output
Sample XML Output
Modify a Point-to-Multipoint RSVP LSP Service
This request is used to modify an RSVP LSP service.
URI | api/space/nsas/rsvp-lsp/service-management/services/{service-Id} |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management.service-status+xml;version=2 |
Produces | Modifies an RSVP LSP service. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>RSVP_BFD_P2P_PATH_001</Name> </Common> <ServiceEndPointGroup> <DeviceInfo> <TA> <DeviceName>embassy</DeviceName> <DeviceID>65604</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterOrderType"> <PathName>Embassy_Path1</PathName> <SetupPriority>4</SetupPriority> <HoldPriority>6</HoldPriority> <ClassOfService>6</ClassOfService> <HopLimit>223</HopLimit> <BandWidth>550</BandWidth> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceEndPointGroup> <DeviceInfo> <TA> <DeviceName>kochin</DeviceName> <DeviceID>65538</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterOrderType"> <PathName>Embassy_Path2</PathName> <SetupPriority>5</SetupPriority> <HoldPriority>6</HoldPriority> <ClassOfService>6</ClassOfService> <HopLimit>233</HopLimit> <BandWidth>550</BandWidth> <StandBy>true</StandBy> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceOrderParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDConfigParameterOrderType"> <RetryLimit>60</RetryLimit> <RetryTimer>30</RetryTimer> <BandWidth>0</BandWidth> <LDPTunneling>Enabled</LDPTunneling> <BFD> <BFDdetection>Primary Path</BFDdetection> <MinInterval>300</MinInterval> <MinReceiveInterval>50</MinReceiveInterval> <Multiplier>3</Multiplier> <NoAdaption>true</NoAdaption> <TransmitMinInterval>50</TransmitMinInterval> <TransmitThreshold>180</TransmitThreshold> <DetectionThreshold>170</DetectionThreshold> <FailureAction>Make before break</FailureAction> <TeardownTimeout>25</TeardownTimeout> </BFD> </ServiceOrderParameter> </ServiceOrder> </ServiceResource> </Data>
Modify a RSVP LSP Service for Edit and Deletion of Paths
This request is used to modify an RSVP LSP service for editing and deleting paths.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Modifies an RSVP LSP service. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>P2MP_BFD_SO_001_modify</Name> </Common> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>embassy</DeviceName> <DeviceID>65604</DeviceID> </Source> <DeviceName>kochin</DeviceName> <DeviceID>65538</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterOrderType"> <PathName>Embassy_Path2</PathName> <SetupPriority>6</SetupPriority> <HoldPriority>5</HoldPriority> <ClassOfService>6</ClassOfService> <HopLimit>234</HopLimit> <BandWidth>500</BandWidth> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceEndPointGroup> <DeviceInfo> <TA> <Source> <DeviceName>embassy</DeviceName> <DeviceID>65604</DeviceID> </Source> <DeviceName>exora</DeviceName> <DeviceID>65552</DeviceID> </TA> </DeviceInfo> <ServiceEndPoint> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDEndPointParameterOrderType"> <PathName>Embassy_Path1</PathName> <SetupPriority>7</SetupPriority> <HoldPriority>5</HoldPriority> <ClassOfService>6</ClassOfService> <HopLimit>244</HopLimit> <BandWidth>700</BandWidth> </ServiceEndpointConfiguration> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceOrderParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="RSVPLSPBFDConfigParameterOrderType"> <RetryLimit>50</RetryLimit> <RetryTimer>30</RetryTimer> <BandWidth>700</BandWidth> <LDPTunneling>Enabled</LDPTunneling> <BFD> <BFDdetection>This LSP</BFDdetection> <MinInterval>300</MinInterval> <MinReceiveInterval>50</MinReceiveInterval> <Multiplier>3</Multiplier> <NoAdaption>true</NoAdaption> <TransmitMinInterval>50</TransmitMinInterval> <TransmitThreshold>300</TransmitThreshold> <DetectionThreshold>300</DetectionThreshold> <FailureAction>Make before break</FailureAction> <TeardownTimeout>28</TeardownTimeout> </BFD> </ServiceOrderParameter> </ServiceOrder> </ServiceResource> </Data>
Force-Deploy an RSVP LSP Service
This request is used to forcibly deploy a previously created RSVP LSP service.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service-management. |
Consumes | application/vnd.net.juniper.space.service-management. The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:
|
Produces | Forcibly deploys a previously created RSVP 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
Decommission an RSVP LSP Service Immediately
This request is used to decommission a previously created RSVP LSP service immediately.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | DELETE |
Content-Type | application/vnd.net.juniper.space.service-management.service+xml |
Produces | Decommissions a previously created RSVP LSP service immediately. |
Input
Sample XML Input
No payload is supported or required
Output
Sample XML Output
<RESTOperation xmlns="services.schema.networkapi.jmp.juniper.net">
<Response>
<Job>
<ID>1540110</ID>
<Status>INPROGRESS</Status>
</Job>
<Identity>
<Type>Service</Type>
<Value>2850823</Value>
</Identity>
<Data>
<OperationSpecificData>
<ResponseMessage>
<HTTPResponseCode>200</HTTPResponseCode>
<ResponseMessage>Service Decommission was Successfully triggered.
Please check the status using the JOB ID.</ResponseMessage>
</ResponseMessage>
</OperationSpecificData>
</Data>
</Response>
</RESTOperation>
Decommission an RSVP LSP Service Later
This request is used to decommission a previously created RSVP LSP service at a later time.
URI | api/space/nsas/rsvp-lsp/service-management/ |
HTTP Method | DELETE |
Content-Type | application/vnd.net.juniper.space.service-management.service+xml |
Produces | Decommissions a previously created RSVP 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>
Get Services for LSP Service Definition
This request is used to retrieve services for an LSP Service Definition.
URL | /api/space/nsas/rsvp-lsp/service-management/services/servicesfordefn/<defn-id> |
HTTP Method | GET |
Sample URL | https://192.0.2.10:8443/api/space/nsas/rsvp-lsp/service-management/services/servicesfordefn/9 |
Accept Header | application/vnd.net.juniper.space.service-management.services+xml;version=2 |
Content Type | application/vnd.net.juniper.space.service-management.services+xml |
Request
Not applicable
Response
""<?xml version=""1.0"" encoding=""UTF-8""?>
<Data xmlns=""services.schema.networkapi.jmp.juniper.net"">
<ServiceResource size=""1"">
<Service key=""1"" uri=""/api/space/nsas/rsvp-lsp/service-management/services/1"" href=""/api/space/nsas/rsvp-lsp/service-management/services/1"">
<Common>
<Name>Test1</Name>
<Identity>1</Identity>
<State>Deployed</State>
<CreatedDate>2018-06-19T01:22:52.000+05:30</CreatedDate>
<LastUpdatedDate>2018-06-19T01:22:52.000+05:30</LastUpdatedDate>
<CreatedFrom>Tunnel</CreatedFrom>
<DeployBy>CSD</DeployBy>
</Common>
<ServiceType>LSP</ServiceType>
<RSVPLSPTopologyType>P2P</RSVPLSPTopologyType>
<AuditFlag>
<FunctionalAudit>Pending</FunctionalAudit>
<FaultStatus>None</FaultStatus>
</AuditFlag>
<Reference>
<ServiceOrder uri=""/api/space/nsas/rsvp-lsp/service-management/service-orders/1"" href=""/api/space/nsas/rsvp-lsp/service-management/service-orders/1"" key=""1"" />
<ServiceDefinition>
<ServiceDefinitionID uri=""/api/space/nsas/rsvp-lsp/service-management/service-definitions/9"" href=""/api/space/nsas/rsvp-lsp/service-management/service-definitions/9"" key=""9"" />
</ServiceDefinition>
</Reference>
</Service>
</ServiceResource>
</Data>"
"