Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-Line LDP Services Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director E-Line LDP Services Management RESTful Web Services.

Get All E-Line LDP Services

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) LDP services.

URI

api/space/nsas/eline-ptp/service-management/services

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.servicesxml

Produces

Collects all the configured E-Line LDP services.

Output

Sample XML Output

Get All E-Line Services By Customer ID or Name

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) services based on customer name or customer ID.

URI

api/space/nsas/eline-ptp/service-management/

services?customerId=360448

api/space/nsas/eline-ptp/service-management/

services?customerName=Customer_005

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects all the configured E-Line LDP services based on the customer name or ID.

Output

Sample XML Output

Get All E-Line Services with Pagination, Search, and Filter

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) services with pagination, and to filter the results based on the search criteria

URI

api/space/nsas/eline-ptp/service-management/

services?start=2&limit=3&sortorder=asc&sortedby=Name&filteredby="Name::Eline

api/space/nsas/eline-ptp/service-management/

services?start=2&limit=3

api/space/nsas/eline-ptp/service-management/

services?paging=(start eq 2, limit eq 3)

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects all the configured E-Line LDP services with pagination applied, and with a filtered result-set that matches the search criteria

Note

For service orders, you can sort with “sortedby=CreatedDate” and “sortedby=State”.

For Start and Limit attributes, you can provide integer values based on your requirement to sort and filter the API output. Sortorder can be “asc” and “desc”. The SortedBy attribute differs based on the APIs. For service orders, the SortedBy option can be “CtreatedDate”, “State”. For services, the SortedBy option can be “Name”, “LastModifiedDate”. The FilteredBy attribute differs based on the APIs. For service orders, the FilteredBy option can be “Name” and “State”. For services, the FilteredBy option can be “Name”.

If you enter “paging=(starteq 2, limit eq 3)”, which is not a single integer value, the display is according to index of records. In this case, it shows from the first indexed record to the third indexed record. If you enter "start=2&limit=3", it starts from the second record and displays the next three records in all.

You can specify multiple key:value pairs with the FilteredBy attribute. For example, to get service orders, you can use Get ServiceOrders with Name and State as “filteredby=Name::L3VPN@@State::Invalid”. Similarly, to get service orders, you can use with Name OR state “filteredby=Name::L3VPN!! State::Invalid”.

Output

Sample XML Output

Get All E-Line Services with Pagination

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) services with pagination.

URI

api/space/nsas/eline-ptp/service-management/

services?start=2&limit=3

api/space/nsas/eline-ptp/service-management/

services?paging=(start eq 2, limit eq 3)

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects all the configured E-Line LDP services with pagination applied

Note

For service orders, you can sort with “sortedby=CreatedDate” and “sortedby=State”.

For Start and Limit attributes, you can provide integer values based on your requirement to sort and filter the API output. Sortorder can be “asc” and “desc”. The SortedBy attribute differs based on the APIs. For service orders, the SortedBy option can be “CtreatedDate”, “State”. For services, the SortedBy option can be “Name”, “LastModifiedDate”. The FilteredBy attribute differs based on the APIs. For service orders, the FilteredBy option can be “Name” and “State”. For services, the FilteredBy option can be “Name”.

If you enter “paging=(starteq 2, limit eq 3)”, which is not a single integer value, the display is according to index of records. In this case, it shows from the first indexed record to the third indexed record. If you enter "start=2&limit=3", it starts from the second record and displays the next three records in all.

You can specify multiple key:value pairs with the FilteredBy attribute. For example, to get service orders, you can use Get ServiceOrders with Name and State as “filteredby=Name::L3VPN@@State::Invalid”. Similarly, to get service orders, you can use with Name OR state “filteredby=Name::L3VPN!! State::Invalid”.

Output

Sample XML Output

Get an E-Line LDP TDM Service with MC-APS By Service ID

This request is used to retrieve the details of a particular E-Line LDP TDM service with MC-APS based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<serviceId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific E-Line LDP TDM service with MC-APS.

Output

Sample XML Output

Modify an E-Line LDP ATM Service with MC-APS

This request is used to modify a previously configured E-Line LDP ATM service with multichassis automatic protection switching (MC-APS) specified.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service with TDM interfaces and multi-segment pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line LDP ATM Service with MC-APS By Service ID

This request is used to retrieve the details of a particular E-Line LDP ATM service with MC-APS based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<serviceId>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml

Produces

Collects the details of a specific E-Line LDP ATM service with MC-APS.

Output

Sample XML Output

Get E-Line LDP Service Details for Multi-Segment Pseudowires By Service ID

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) LDP service with a multi-segment pseudowire based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with a multi-segment pseudowire.

Output

Sample XML Output

Get E-Line LDP Service Details for Static Pseudowires By Service ID

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) LDP service with a static pseudowire based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with a static pseudowire.

Output

Sample XML Output

Get E-Line LDP Service Details with MC-LAG Interfaces By Service ID

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) LDP service with multichassis link aggregation (MC-LAG) interfaces based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with MC-LAG interfaces.

Output

Sample XML Output

Get E-Line LDP Service Details with Pseudowire Redundancy By Service ID

This request is used to retrieve the details of a particular E-Line LDP service with pseudowire redundancy based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with pseudowire redundancy by service ID.

Output

Sample XML Output

Get E-Line LDP Service Details with Burst Size Calculation By Service ID

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) LDP service with burst size calculation based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with burst size calculation.

Output

Sample XML Output

Get E-Line Service Details with Normalization Support By Service ID

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) service configured with normalization of VLANs and logical interface unit-handling, based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line service configured with normalization of VLANs and logical unit of interfaces.

Output (VLAN Normalization: Normalize to Q-in-Q tags)

Sample XML Output

Output (VLAN Normalization: Normalize to dot1Q tags)

Sample XML Output

Get E-Line LDP TDM Service Details with CESoPSN Support By Service ID

This request is used to retrieve the details of a particular EPL or E-Line LDP service configured with time division multiplexed (TDM) Circuit Emulation Service over Packet-Switched Network (CESoPSN), based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with TDM CESoPSN configured.

Output

Sample XML Output

Get E-Line LDP TDM Service Details with Multi-Segment Pseudowire By Service ID

This request is used to retrieve the details of a particular E-Line LDP service configured that contains TDM interfaces with multi-segment pseudowires for E-Line LDP TDM, based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with TDM interfaces and a multi-segment pseudowire.

Output

Sample XML Output

Get E-Line LDP ATM Service Details with Multi-Segment Pseudowire By Service ID

This request is used to retrieve the details of a particular E-Line LDP service configured that contains ATM interfaces with multi-segment pseudowires for E-Line LDP ATM, based on the service ID.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

services+xml;version=2

Produces

Collects the details of a specific E-Line LDP service with ATM interfaces and a multi-segment pseudowire.

Output

Sample XML Output

Stitch an E-Line LDP Service with Multi-Segment Pseudowire

This request is used to stitch an E-Line LDP service with multi-segment pseudowires.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.stitching-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Stitches an E-Line LDP service with multi-segment pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Stitch an E-Line LDP TDM Service with Multi-Segment Pseudowire

This request is used to stitch an E-Line LDP TDM service with multi-segment pseudowires.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.stitching-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Stitches an E-Line LDP TDM service with multi-segment pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Stitch an E-Line LDP ATM Service with Multi-Segment Pseudowire

This request is used to stitch an E-Line LDP ATM service with multi-segment pseudowires.

URI

api/space/nsas/eline-ptp/service-management/

services/<service-Id>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.stitching-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Stitches an E-Line LDP ATM service with multi-segment pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP Service with Pseudowire Redundancy

This request is used to modify an E-Line LDP service with pseudowire redundancy. You cannot edit MC-LAG interface settings when you modify a service.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service with pseudowire redundancy.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP TDM Service with CESoPSN Support for E-Line

This request is used to modify an E-Line LDP TDM service configured with CESoPSN for E-Line.

URI

api/space/nsas/eline-ptp/service-management/services/

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 E-Line LDP TDM service with CESoPSN for E-Line.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP Service

This request is used to modify an E-Line LDP service. You cannot modify MC-LAG settings while you modify a service.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP Service with Static Pseudowire

This request is used to modify an E-Line LDP service with static pseudowires.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service with static pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP Service

This request is used to modify an E-Line LDP service.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line LDP TDM Service with MC-APS

This request is used to modify a previously configured E-Line LDP TDM service with multichassis automatic protection switching (MC-APS) specified.

URI

api/space/nsas/eline-ptp/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 E-Line LDP service with ATM interfaces and multi-segment pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Clone an E-Line LDP Service with Static Pseudowire for E-Line

This request is used to clone an E-Line LDP service with static pseudowires for E-Line.

URI

api/space/nsas/eline-ptp/service-management/

services/clone/<serviceId>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.clone-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Clones an E-Line LDP service with static pseudowires for E-Line.

Note

To clone services, for elements in <ServiceEndPoint>, the following list of elements is not allowed in <ServiceEndPoint>

  • TrafficType

  • PhysicalEncapsulation

  • LogicalEncapsulation

  • CellBundleSize

  • OutGoingLabel

  • JitterBuffer

  • IdlePattern

  • PayloadSize

  • ExcessivePacketLossRate

If you enter any of the preceding elements for <ServiceendPoint>, an appropriate error message is displayed.

Also, ServiceDefinition must not be provided in the <Reference> tag; this value is ignored because it must be the same as the service you are cloning.

Similarly, you cannot specify a different customer while cloning a service because the same <Reference> tag that is used for creating a service is used in cloning a service. As a result, the same customer during service creation is used and a you cannot provide different customer in the clone request.

Input

Sample XML Input

Output

Sample XML Output

Clone an E-Line Service

This request is used to clone an E-Line service.

URI

api/space/nsas/eline-ptp/service-management/

services/clone/<serviceId>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.clone-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Clones an E-Line service.

Note

To clone services, for elements in <ServiceEndPoint>, the following list of elements is not allowed in <ServiceEndPoint>

  • TrafficType

  • PhysicalEncapsulation

  • LogicalEncapsulation

  • CellBundleSize

  • OutGoingLabel

  • JitterBuffer

  • IdlePattern

  • PayloadSize

  • ExcessivePacketLossRate

If you enter any of the preceding elements for <ServiceendPoint>, an appropriate error message is displayed.

Also, ServiceDefinition must not be provided in the <Reference> tag; this value is ignored because it must be the same as the service you are cloning.

Similarly, you cannot specify a different customer while cloning a service because the same <Reference> tag that is used for creating a service is used in cloning a service. As a result, the same customer during service creation is used and a you cannot provide different customer in the clone request.

Input

Sample XML Input

Output

Sample XML Output

Force-Deploy an E-Line Service

This request is used to forcibly deploy a previously created E-Line service.

URI

api/space/nsas/eline-ptp/service-management/

services/{serviceId}

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:

  • DeployNow

  • DeployLater

Produces

Forcibly deploys a previously created E-Line service.

Input

Sample XML Input

Output

Sample XML Output

Force-Deploy an E-Line LDP Service

This request is used to forcibly deploy a previously created E-Line LDP service.

URI

api/space/nsas/eline-ptp/service-management/

services/{serviceId}

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:

  • DeployNow

  • DeployLater

Produces

Forcibly deploys a previously created E-Line LDP service.

Input

Sample XML Input

Output

Sample XML Output

Decommission an E-Line Service Immediately

This request is used to decommission a previously created E-Line service immediately.

URI

api/space/nsas/eline-ptp/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.service-management.

service+xml

Produces

Decommissions a previously created E-Line service immediately.

Input

Sample XML Input

Output

Sample XML Output

Decommission an E-Line LDP Service Immediately

This request is used to decommission a previously created E-Line LDP service immediately.

URI

api/space/nsas/eline-ptp/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

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

Produces

Decommissions a previously created E-Line LDP service immediately.

Input

Sample XML Input

Output

Sample XML Output

Decommission an E-Line Service Later

This request is used to decommission a previously created E-Line service at a defined later time.

URI

api/space/nsas/eline-ptp/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.service-management.

service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Decommissions a previously created E-Line service at a scheduled later time.

Input

Sample XML Input

Output

Sample XML Output

Delete an E-Line LDP Service

This request is used to delete a previously configured E-Line LDP service.

URI

api/space/nsas/eline-ptp/service-management/

services/<serviceOrder-id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-management.

services+xml

Produces

Deletes an E-Line LDP service.

Output

Sample XML Output

View the Pending Configuration of an E-Line Service

This request is used to view the details of a E-Line service that are pending to be applied to a device.

URI

api/space/nsas/eline-ptp/service-management/

services/view-pendingorderconfiguration/<serviceOrder-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.

service-management.pendingorder-config+xml

Produces

Displays the configuration details of a service pending to be applied to a device.

Output

Sample XML Output

Clone an E-Line LDP Service

This request is used to clone an E-Line LDP service.

URI

api/space/nsas/eline-ptp/service-management/services/

clone/<serviceId>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.clone-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Clones an E-Line LDP service.

Note

To clone services, for elements in <ServiceEndPoint>, the following list of elements is not allowed in <ServiceEndPoint>

  • TrafficType

  • PhysicalEncapsulation

  • LogicalEncapsulation

  • CellBundleSize

  • OutGoingLabel

  • JitterBuffer

  • IdlePattern

  • PayloadSize

  • ExcessivePacketLossRate

If you enter any of the preceding elements for <ServiceendPoint>, an appropriate error message is displayed.

Also, ServiceDefinition must not be provided in the <Reference> tag; this value is ignored because it must be the same as the service you are cloning.

Similarly, you cannot specify a different customer while cloning a service because the same <Reference> tag that is used for creating a service is used in cloning a service. As a result, the same customer during service creation is used and a you cannot provide different customer in the clone request.

Input

Sample XML Input

Output

Sample XML Output

Clone an E-Line LDP Service (Version 2)

This request is used to clone an E-Line LDP service.

URI

api/space/nsas/eline-ptp/service-management/services/

clone/<serviceId>

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-

management.clone-service+xml;version=2;charset=UTF-8

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml;version=2

Produces

Clones an E-Line LDP service in version 2 format.

Note

To clone services, for elements in <ServiceEndPoint>, the following list of elements is not allowed in <ServiceEndPoint>

  • TrafficType

  • PhysicalEncapsulation

  • LogicalEncapsulation

  • CellBundleSize

  • OutGoingLabel

  • JitterBuffer

  • IdlePattern

  • PayloadSize

  • ExcessivePacketLossRate

If you enter any of the preceding elements for <ServiceendPoint>, an appropriate error message is displayed.

Also, ServiceDefinition must not be provided in the <Reference> tag; this value is ignored because it must be the same as the service you are cloning.

Similarly, you cannot specify a different customer while cloning a service because the same <Reference> tag that is used for creating a service is used in cloning a service. As a result, the same customer during service creation is used and a you cannot provide different customer in the clone request.

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line Service to Associate an LSP

This request is used to retrieve an E-Line service for associating an LSP with the service.

URL

/api/space/nsas/eline-ptp/service-management/services/<orderID>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/eline-ptp/service-management/services/196608

Accept

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

Content Type

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

Request

Not Applicable

Response