Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-Line LDP Service Definitions Management RESTful Web Services

 

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

Get All E-Line LDP Service Definitions

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

URI

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

HTTP Method

GET

Consumes

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

service-definitions+xml

Produces

Collects all the configured E-Line LDP service definitions.

Output

Sample XML Output

Get All PublishedE-Line Service Definitions

This request is used to retrieve all the publishedE-Line service definitions.

URI

All service types:

/api/space/nsas/service-management/

service-definitions/published

E-Line :

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

service-definitions/published

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Content Type

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

service-definitions+xml;charset=UTF-8

Produces

Collects all the published E-Line service definitions.

Output

Sample XML Output

Get All E-Line Service Definitions by Filter Criterion

This request is used to retrieve all the configured E-Line service definitions that match the specified filter criterion. You can filter and retrieve service definitions based on the name, service type, signaling type, and state.

URI

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

definitions?filteredby=State::unPublished

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

definitions?filteredby=Name::CreateP2PSD01

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

definitions?filteredby=ServiceType::P2P(ETHERNET)

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

definitions?filteredby=Signaling::LDP

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured E-Line service definitions that match the filter criteria

Note

For E-Line, IP, and E-LAN service definitions, the FilteredBy option can be Name, ServiceType, Signaling, and State.

Output

Sample XML Output

Get All E-Line LDP Service Definitions with Pagination

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

URI

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

service-definitions?start=4&limit=2

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

service-definitions?paging=(start eq 4, limit eq 2)

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured E-Line LDP service definitions 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 All E-Line LDP Service Definitions with Pagination, Search, and Filter

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

URI

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

service-definitions?start=4&limit=2

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

service-definitions?paging=(start eq 4, limit eq 2)

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured E-Line LDP service definitions 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 an E-Line LDP Service Definition By Definition ID

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml

Produces

Collects the details of a specific E-Line LDP service definition.

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output

Sample XML Output

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

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

URI

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

<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output

Sample XML Output

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

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

URI

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

<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

Collects the details of a specific E-LINE service definition configured with normalization of VLANs.

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 Definition Details with CESoPSN Support By Definition ID

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

URI

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

<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output

Sample XML Output

Create an E-Line LDP Service Definition with Ethernet Option as Asymmetric Tag Depth

This request is used to create an E-Line LDP service definition configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option.

URI

api/space/nsas/eline-ptp/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 an E-Line LDP service definition configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP Service Definition with Ethernet Interfaces

This request is used to create an E-Line LDP service definition configured with Ethernet interfaces.

URI

api/space/nsas/eline-ptp/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 an E-Line LDP service definition configured with interfaces that contain Ethernet encapsulation.

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP Ethernet Service Definition with Multi-Segment Pseudowire

This request is used to create an E-Line LDP service definition for Ethernet interfaces with multi-segment pseudowires.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line Service Definition with VLAN Normalization

This request is used to create an E-Line service definition configured with VLAN normalization types.

URI

api/space/nsas/eline-ptp/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 an E-Line service definition configured with VLAN normalization types.

Input (VLAN Normalization: Normalize to QinQ tags)

Sample XML Input

Input (VLAN Normalization: Normalize to dot1Q tags)

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP TDM Service Definition with CESoPSN

This request is used to create an E-Line LDP service definition with time division multiplexed (TDM) Circuit Emulation Service over Packet-Switched Network (CESoPSN).

URI

api/space/nsas/eline-ptp/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 an E-Line LDP service definition with time division multiplexed (TDM) Circuit Emulation Service over Packet-Switched Network (CESoPSN).

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP TDM Service Definition with Multi-Segment Pseudowire forE-Line

This request is used to create an E-Line LDP service definition with TDM interfaces and multi-segment pseudowires forE-Line.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP ATM Service Definition with Multi-Segment Pseudowire

This request is used to create an E-Line LDP service definition with ATM interfaces and multi-segment pseudowires.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line LDP Service Definition with Static Pseudowire forE-Line

This request is used to create an E-Line LDP service definition with static pseudowires forE-Line.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Publish and Unpublish an E-Line LDP Service Definition

This request is used to publish or unpublish an E-Line LDP service definition.

URI

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

HTTP Method

POST

Content-Type

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

Consumes

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

service-definition-status+xml

Action types are Publish and Unpublish.

Produces

Publishes or unpublishes an E-Line LDP service definition.

Input for Publishing a Service Definition

Sample XML Input

Output

Sample XML Output

Delete an E-Line LDP Service Definition

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

URI

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

service-definitions/<servicedefinition-id>

HTTP Method

DELETE

Consumes

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

service-definition+xml

Produces

Deletes an E-Line LDP service definition.

Output

Sample XML Output

Create an E-Line LDP ATM Service Definition with MC-APS

This request is used to create an E-Line LDP ATM service definition configured with MC-APS.

URI

api/space/nsas/eline-ptp/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 an E-Line LDP service definition configured with MC-APS.

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

Produces

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

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

Produces

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

Output

Sample XML Output

Create an E-Line LDP TDM Service Definition with MC-APS

This request is used to create an E-Line LDP TDM service definition configured with MC-APS.

URI

api/space/nsas/eline-ptp/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 an E-Line LDP TDM service definition configured with MC-APS.

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line LDP Service Definition with Default Service Template By Definition ID

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml

Produces

Collects the details of a specific E-Line LDP service definition with default service template.

Output

Sample XML Output

Create an E-Line LDP Service Definition with Default Service Template

This request is used to create an E-Line LDP TDM service definition configured with default service template.

URI

api/space/nsas/eline-ptp/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 an E-Line LDP service definition configured with default service template.

The XPath tag in a service template attribute is optional and we recommend that you use this tag.

Input

Sample XML Input

Sample XML Input (With XPath)

Output

Sample XML Output