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

    RSVP and Static LSP Service Templates Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Service Templates Management RESTful Web Services for RSVP and static LSP services.

    Get All RSVP LSP Service Templates

    This request is used to retrieve all the configured RSVP LSP service templates.

    URI

    api/space/nsas/rsvp-lsp/service-management/service-templates

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Collects all the configured RSVP LSP service templates.

    Output

    Sample XML Output

    Get an RSVP LSP Service Template by Template ID

    This request is used to retrieve a specific RSVP LSP service template, based on the template ID.

    URI

    api/space/nsas/rsvp-lsp/service-management/service-templates/
    <templateId>

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Retrieves the details of a specific configured RSVP LSP service template.

    Output

    Sample XML Output

    Get an RSVP LSP Service Template by Service Definition ID

    This request is used to retrieve a specific RSVP LSP service template, based on the service definition ID.

    URI

    api/space/nsas/rsvp-lsp/service-management/service-definitions/
    295160/serviceTemplates

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Retrieves the details of a specific configured RSVP LSP service template based on a service definition ID.

    Output

    Sample XML Output

    Get an RSVP LSP Service Order Associated with a Service Template by Service Order ID

    This request is used to retrieve a specific RSVP LSP service order that is attached to a service template, based on the service order ID.

    URI

    api/space/nsas/rsvp-lsp/service-management/service-orders/
    <ServiceOrderID>

    HTTP Method

    GET

    Consumes

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

    Produces

    Retrieves the details of a specific configured RSVP LSP service order that contains a service template based on a service order ID.

    Output

    Sample XML Output

    Get an RSVP LSP Service Definition Associated with a Service Template by Service Definition ID

    This request is used to retrieve a specific RSVP LSP service definition that is attached to a service template, based on the service definition ID.

    URI

    api/space/nsas/rsvp-lsp/service-management/service-definitions/
    <ServiceDefinitionID>

    HTTP Method

    GET

    Consumes

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

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

    Produces

    Retrieves the details of a specific configured RSVP LSP service definition that contains a service template based on a service definition ID.

    Output

    Sample XML Output

    Create a Service Definition Associated with a Service Template

    This request is used to create a service definition configured with a service template.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    Produces

    Creates a service definition configured with a service template

    Input

    Sample XML Input

    Create a Service Order Associated with a Service Template

    This request is used to create a service order configured with a service template.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    Produces

    Creates a service order configured with a service template

    Input

    Sample XML Input

    Get an RSVP LSP Service Associated with a Service Template By Service ID

    This request is used to retrieve the details of a particular RSVP LSP service that is configured with a service template, based on the service identifier.

    URI

    api/space/nsas/rsvp-lsp/service-management/
    services/<serviceId>

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects the details of a specific RSVP LSP service that contains a service template.

    Output

    Sample XML Output

    Modify an RSVP LSP Service Associated with a Service Template

    This request is used to modify an RSVP LSP service that contains a service template.

    URI

    api/space/nsas/rsvp-lsp/service-management/
    services/{service-Id}

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.service-
    management.
    modify-service+xml;version=2;charset=UTF-8

    Consumes

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

    Produces

    Modifies an RSVP LSP service that contains a service template.

    Input

    Sample XML Input

    Get All Static LSP Service Templates

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

    URI

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

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Collects all the configured Static LSP service templates.

    Output

    Sample XML Output

    Get an Static LSP Service Template by Template ID

    This request is used to retrieve a specific Static LSP service template, based on the template ID.

    URI

    api/space/nsas/static-lsp/service-management/service-templates/
    <templateId>

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Retrieves the details of a specific configured Static LSP service template.

    Output

    Sample XML Output

    Get an Static LSP Service Template by Service Definition ID

    This request is used to retrieve a specific Static LSP service template, based on the service definition ID.

    URI

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

    HTTP Method

    GET

    Consumes

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

    application/vnd.net.juniper.space.service-management.
    service-templates+json

    Produces

    Retrieves the details of a specific configured Static LSP service template based on a service definition ID.

    Output

    Sample XML Output

    Get an Static LSP Service Order Associated with a Service Template by Service Order ID

    This request is used to retrieve a specific Static LSP service order that is attached to a service template, 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

    Produces

    Retrieves the details of a specific configured Static LSP service order that contains a service template based on a service order ID.

    Output

    Sample XML Output

    Get an Static LSP Service Definition Associated with a Service Template by Service Definition ID

    This request is used to retrieve a specific Static LSP service definition that is attached to a service template, based on the service definition ID.

    URI

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

    HTTP Method

    GET

    Consumes

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

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

    Produces

    Retrieves the details of a specific configured Static LSP service definition that contains a service template based on a service definition ID.

    Output

    Sample XML Output

    Create a Service Definition Associated with a Service Template

    This request is used to create a service definition configured with a service template.

    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;version=2;charset=UTF-8

    Consumes

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

    Produces

    Creates a service definition configured with a service template

    Input

    Sample XML Input

    Create a Service Order Associated with a Service Template

    This request is used to create a service order configured with a service template.

    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;version=2;charset=UTF-8

    Consumes

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

    Produces

    Creates a service order configured with a service template

    Input

    Sample XML Input

    Get an Static LSP Service Associated with a Service Template By Service ID

    This request is used to retrieve the details of a particular Static LSP service that is configured with a service template, based on the service identifier.

    URI

    api/space/nsas/static-lsp/service-management/
    services/<serviceId>

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects the details of a specific Static LSP service that contains a service template.

    Output

    Sample XML Output

    Modify an Static LSP Service Associated with a Service Template

    This request is used to modify an Static LSP service that contains a service template.

    URI

    api/space/nsas/static-lsp/service-management/
    services/{service-Id}

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.service-
    management.
    modify-service+xml;version=2;charset=UTF-8

    Consumes

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

    Produces

    Modifies an Static LSP service that contains a service template.

    Input

    Sample XML Input

    Get LSP Service Details with Endpoints Paginated

    This request is used to modify L3VPN Services Management RESTful Web ServicesLSP service details with endpoints paginated.

    URI

    /api/space/nsas/rsvp-lsp/service-management/
    services/{service-Id}

    HTTP Method

    GET

    Content-Type

    application/vnd.net.juniper.space.service-
    management.
    modify.service+xml;version=2;charset=UTF-8

    Consumes

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

    Produces

    Modifies an LSP service details with endpoints paginated.

    Output

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="true"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
    <Service href="/api/space/nsas/rsvp-lsp/service-management/services/524325" uri="/api/space/nsas/rsvp-lsp/service-management/services/524325" key="524325">
    <Common>
    <Name>LSP_002</Name>
    <Identity>524325</Identity>
    <State>Deployed</State>
    <CreatedDate>2016-06-16T11:05:07.000+05:30</CreatedDate>
    <LastUpdatedDate>2016-06-16T18:36:33.000+05:30</LastUpdatedDate>
    </Common>
    <ServiceType>LSP</ServiceType>
    <LSPPattern href="/api/space/nsas/lsp-pattern/service-management/service-patterns/134" uri="/api/space/nsas/lsp-pattern/service-management/service-patterns/134" key="134">
    <PatternName>Default LSP Pattern</PatternName>
    <PatternID>134</PatternID>
    <PatternTemplate>$Name_to_$EgressLoopbackAddress</PatternTemplate>
    </LSPPattern>
    <AuditFlag>
    <FunctionalAudit>Pending</FunctionalAudit>
    <FaultStatus>None</FaultStatus>
    <SLAStatus>None</SLAStatus>
    <OverallStatus>N/A</OverallStatus>
    </AuditFlag>
    <ServiceEndPointGroup>
    <DeviceList>
    <FMDeviceDetails href="/api/space/nsas/prestage-ta-device/manage-devices/devices/851980" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/851980">
    <DeviceName>anjar</DeviceName>
    <IPAddress>10.213.15.6</IPAddress>
    <CMPDeviceID>851980</CMPDeviceID>
    <DeviceID>229379</DeviceID>
    <DeviceState>In Sync</DeviceState>
    <ConnectionStatus>up</ConnectionStatus>
    <PlatformType>srx220h</PlatformType>
    <OsVersion>12.1X45-D15.5</OsVersion>
    <Role>N_PE</Role>
    </FMDeviceDetails>
    <FMDeviceDetails href="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966134" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966134">
    <DeviceName>PE4_re0</DeviceName>
    <IPAddress>10.220.11.54</IPAddress>
    <CMPDeviceID>1966134</CMPDeviceID>
    <DeviceID>295093</DeviceID>
    <DeviceState>In Sync</DeviceState>
    <ConnectionStatus>up</ConnectionStatus>
    <PlatformType>mx240</PlatformType>
    <OsVersion>14.2-20150126.0</OsVersion>
    <Role>N_PE</Role>
    </FMDeviceDetails>
    <FMDeviceDetails href="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966132" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966132">
    <DeviceName>P1_re0</DeviceName>
    <IPAddress>10.220.18.200</IPAddress>
    <CMPDeviceID>1966132</CMPDeviceID>
    <DeviceID>295088</DeviceID>
    <DeviceState>In Sync</DeviceState>
    <ConnectionStatus>up</ConnectionStatus>
    <PlatformType>mx960</PlatformType>
    <OsVersion>14.2-20150126.0</OsVersion>
    <Role>N_PE</Role>
    </FMDeviceDetails>
    <FMDeviceDetails href="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966140" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/1966140">
    <DeviceName>P2_re0</DeviceName>
    <IPAddress>10.220.17.99</IPAddress>
    <CMPDeviceID>1966140</CMPDeviceID>
    <DeviceID>491526</DeviceID>
    <DeviceState>In Sync</DeviceState>
    <ConnectionStatus>up</ConnectionStatus>
    <PlatformType>mx960</PlatformType>
    <OsVersion>14.2-20150126.0</OsVersion>
    <Role>N_PE</Role>
    </FMDeviceDetails>
    </DeviceList>
    </ServiceEndPointGroup>
    <ServiceParameters xsi:type="RSVPLSPBFDConfigParameterServiceType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <RetryTimer>30</RetryTimer>
    <LDPTunneling>Disabled</LDPTunneling>
    <AutoBandWidth>
    <AutoBandwidth>false</AutoBandwidth>
    <AdjustInterval>0</AdjustInterval>
    <MaxBandwidth>0</MaxBandwidth>
    <MinBandwidth>0</MinBandwidth>
    </AutoBandWidth>
    <ProtectionSetting>
    <LSPProtectionType>Path Protection</LSPProtectionType>
    <LocalProtection>N/A</LocalProtection>
    <EnableFR>Disabled</EnableFR>
    </ProtectionSetting>
    <HopLimit>255</HopLimit>
    <StandBy>false</StandBy>
    <Adaptive>Disabled</Adaptive>
    <SetupPriority>7</SetupPriority>
    <HoldPriority>0</HoldPriority>
    </ServiceParameters>
    <Reference>
    <ServiceOrder href="/api/space/nsas/rsvp-lsp/service-management/service-orders/524306" uri="/api/space/nsas/rsvp-lsp/service-management/service-orders/524306" key="524306"/>
    <ServiceDefinition>
    <ServiceDefinitionID href="/api/space/nsas/rsvp-lsp/service-management/service-definitions/524288" uri="/api/space/nsas/rsvp-lsp/service-management/service-definitions/524288" key="524288"/>
    </ServiceDefinition>
    </Reference>
    </Service>
    </ServiceResource>
    </Data>

    Get LSP Details

    This request is used to modify an LSP service details in version 1 format.

    URI

    /api/space/nsas/rsvp-lsp/service-management/
    services/{service-Id}

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.service-
    management.
    modify.service+xml;version=2;charset=UTF-8

    Consumes

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

    Produces

    Gets LSP details.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="true"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
    <Service>
    <ServiceEndPointGroup>
    <DeviceInfo>
    <TA>
    <Source href="/api/space/nsas/prestage-ta-device/manage-devices/devices/295088" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/295088" key="295088">
    <DeviceName>P1_re0</DeviceName>
    <DeviceID>295088</DeviceID>
    <CMPDeviceID>1966132</CMPDeviceID>
    </Source>
    <Destination href="/api/space/nsas/prestage-ta-device/manage-devices/devices/491526" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/491526" key="491526">
    <DeviceName>P2_re0</DeviceName>
    <DeviceID>491526</DeviceID>
    <CMPDeviceID>1966140</CMPDeviceID>
    </Destination>
    <LSPName>LSP_002_to_22_22_22_22</LSPName>
    </TA>
    </DeviceInfo>
    <ServiceEndPoint>
    <ServiceEndpointConfiguration xsi:type="RSVPLSPEndPointParameterServiceType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <PrimaryPath>
    <PathName>MyPath-01</PathName>
    <SetupPriority>7</SetupPriority>
    <Adaptive>Disabled</Adaptive>
    <HoldPriority>0</HoldPriority>
    <HopLimit>255</HopLimit>
    <Bandwidth>-1000</Bandwidth>
    <AdminGroups/>
    </PrimaryPath>
    </ServiceEndpointConfiguration>
    <ServiceTemplates/>
    </ServiceEndPoint>
    </ServiceEndPointGroup>
    </Service>
    </ServiceResource>
    </Data>

    Submit a Modified Service (Version 2)

    This request is used to modify an LSP service in version 1 format.

    URI

    /api/space/nsas/rsvp-lsp/service-management/
    services/{service-Id}

    HTTP Method

    POST

    Content-Type

    */*

    Consumes

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

    Produces

    Submits a modified service.

    Input

    Sample XML Input

    <?xml version="1.0"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
    <ServiceOrder>
    <Common>
    <Name>LSP_002_Modify_2016-07-01_14-15-57</Name>
    </Common>
    <ServiceEndPointGroup>
    <DeviceInfo>
    <TA>
    <Source>
    <DeviceName>P1_re0</DeviceName>
    <DeviceID>295088</DeviceID>
    </Source>
    <Destination>
    <DeviceName>P2_re0</DeviceName>
    <DeviceID>491526</DeviceID>
    </Destination>
    </TA>
    </DeviceInfo>
    <ServiceEndPoint>
    <ServiceEndpointConfiguration xsi:type="RSVPLSPBFDEndPointParameterOrderType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <PrimaryPath>
    <PathName>MyPath-01</PathName>
    <SetupPriority>7</SetupPriority>
    <Adaptive>Disabled</Adaptive>
    <HoldPriority>0</HoldPriority>
    <ClassOfService>-1</ClassOfService>
    <HopLimit>255</HopLimit>
    <Bandwidth>-1</Bandwidth>
    <Paths>
    <Path>
    <PathName>MyPath-01</PathName>
    <Connection>Loose</Connection>
    </Path>
    </Paths>
    </PrimaryPath>
    </ServiceEndpointConfiguration>
    </ServiceEndPoint>
    </ServiceEndPointGroup>
    <ServiceOrderParameter xsi:type="RSVPLSPBFDConfigParameterOrderType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ClassOfService>-1</ClassOfService>
    <HopLimit>255</HopLimit>
    <HoldPriority>0</HoldPriority>
    <SetupPriority>7</SetupPriority>
    <StandBy>false</StandBy>
    <Adaptive>Disabled</Adaptive>
    <RetryLimit>-1</RetryLimit>
    <RetryTimer>30</RetryTimer>
    <BandWidth>-1</BandWidth>
    <LDPTunneling>Disabled</LDPTunneling>
    <ProtectionSetting>
    <EnableFR>Disabled</EnableFR>
    </ProtectionSetting>
    <BFD>
    <BFDdetection>None</BFDdetection>
    </BFD>
    </ServiceOrderParameter>
    </ServiceOrder>
    </ServiceResource>
    <CustomAction xsi:type="ServiceCustomActionType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Action>SaveAndValidate</Action>
    </CustomAction>
    </Data>

    Output

    Sample XML Output

    xml version="1.0" encoding="UTF-8" standalone="true"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Status>
    <Identity>
    <Type>Service</Type>
    <Value>524325</Value>
    </Identity>
    <Identity>
    <Type>ServiceOrder</Type>
    <Value>1114113</Value>
    </Identity>
    <Job>
    <ID>4423695</ID>
    <Status>INPROGRESS</Status>
    </Job>
    <Code>200</Code>
    <Message>The Service Modified Successfully and Validation is in Progress. Please check the status using the JOB ID.</Message>
    </Status>
    </Data>

    Modified: 2017-09-13