Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-LAN Service Definitions Management RESTful Web Services

 

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

Get All E-LAN BGP Service Definitions

This request is used to retrieve all the configured E-LAN BGP service definitions.

URI

api/space/nsas/elan-vpls/service-management/service-definitions

HTTP Method

GET

Consumes

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

service-definitions+xml

Produces

Collects all the configured E-LAN BGP service definitions.

Output

Sample XML Output

Get All Published E-LAN Service Definitions

This request is used to retrieve all the published E-LAN service definitions.

URI

All service types:

/api/space/nsas/service-management/

service-definitions/published

E-LAN:

/api/space/nsas/elan-vpls/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-LAN service definitions.

Output

Sample XML Output

Get All E-LAN BGP Service Definitions with Pagination

This request is used to retrieve all the configured E-LAN BGP service definitions with pagination.

URI

api/space/nsas/elan-vpls/service-management/service-definitions

?start=4&limit=2

api/space/nsas/elan-vpls/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-LAN BGP 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-LAN BGP Service Definitions with Pagination, Search, and Filter

This request is used to retrieve all the configured Layer 2 Ethernet LAN (E-LAN) BGP service definitions with pagination, and to filter the results based on the search criteria

URI

api/space/nsas/elan-vpls/service-management/service-definitions

?start=4&limit=2&sortorder=asc&sortedby=Name&filteredby="Name::BGP"

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured E-LAN BGP 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 All E-LAN Service Definitions by Filter Criterion

This request is used to retrieve all the configured E-LAN 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/elan-vpls/service-management/service-

definitions?filteredby=State::Published

/api/space/nsas/elan-vpls/service-management/service-

definitions?filteredby=Name::CreateVPLSSD01

/api/space/nsas/elan-vpls/service-management/service-

definitions?filteredby=ServiceType::VPLS

(Point-MultiPoint)

/api/space/nsas/elan-vpls/service-management/service-

definitions?filteredby=Signaling::BGP

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured E-LAN 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 E-LAN BGP Service Definition Details By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN BGP service definition, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN BGP service definition.

Output

Sample XML Output

Get E-LAN LDP Service Definition Details By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN LDP service definition, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN LDP service definition.

Output

Sample XML Output

Get E-LAN BGP Service Definition Details with Burst Size Calculation By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN BGP service definition with burst size calculation, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN BGP service definition with burst size calculation.

Output

Sample XML Output

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

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN LDP service definition with burst size calculation, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN LDP service definition with burst size calculation.

Output (CalculateBurstSize MTU Based):

Sample XML Output

Output (CalculateBurstSize Line-Rate Based):

Sample XML Output

Get E-LAN LDP Point-to-Multipoint Service Definition Details with Pseudowire Stitching By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN LDP point-to-multipoint service definition with pseudowire stitching, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN LDP point-to-multipoint service definition with pseudowire stitching.

Output

Sample XML Output

Get E-LAN BGP Point-to-Multipoint Service Definition Details with Pseudowire Stitching By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN BGP service definition with pseudowire stitching, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN BGP service definition with pseudowire stitching.

Output

Sample XML Output

Get E-LAN Service Definition Details with Manual Route Target By Definition ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN service definition with manual route target, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN service definition with manual route target..

Output

Sample XML Output

Create an E-LAN BGP Service Definition (without various instance types and multihoming support)

This request is used to create an E-LAN BGP service definition.

URI

api/space/nsas/elan-vpls/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

Produces

Creates an E-LAN BGP service definition.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN BGP Service Definition (with various instance types and multihoming support)

This request is used to create an E-LAN BGP service definition.

URI

api/space/nsas/csd/service-definition

HTTP Method

POST

Content-Type

application/xml

Consumes

application/xml

Produces

Creates an E-LAN BGP service definition.

Input

Sample XML Input

Create an E-LAN Service Definition

This request is used to create an E-LAN service definition.

URI

api/space/nsas/elan-vpls/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

Produces

Creates an E-LAN service definition.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN Service Definition for vpls Instance and vpls Protocol Types

This request is used to create an E-LAN service definition with vpls as the instance and protocol type.

URL

/api/space/nsas/csd/service-definition

Sample URL

https://192.0.2.10:8080/api/space/nsas/csd/service-definition

HTTP Method

POST

Accept Header

application/xml

Content Type

application/xml;

Request

Supported Instance Types and Protocols

  • Instance Type - vlps

  • Protocol - vlps

  • Instance Type - virtual-switch

  • Protocol - vpls, evpn, evpn-etree

  • Instance Type - evpn

  • Protocol - evpn, evpn-etree

Response

Create an E-LAN BGP Service Definition with Burst Size

This request is used to create an E-LAN BGP service definition with burst size configured.

URI

api/space/nsas/elan-vpls/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

Produces

Creates an E-LAN LDP service definition with burst size.

Input (MTU-Based Burst Size)

Sample XML Input

Input (Line Rate-Based Burst Size)

Sample XML Input

Output

Sample XML Output

Publish and Unpublish an E-LAN BGP Service Definition

This request is used to publish or unpublish an E-LAN BGP service definition.

URI

api/space/nsas/elan-vpls/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-LAN BGP service definition.

Input for Unpublishing a Service Definition

Sample XML Input

Output

Sample XML Output

Input for Publishing a Service Definition

Sample XML Input

Output

Sample XML Output

Delete an E-LAN BGP Service Definition

This request is used to delete a previously configured E-LAN BGP service definition.

URI

api/space/nsas/elan-vpls/service-management/service-definitions/

<servicedefinition-id>

HTTP Method

DELETE

Consumes

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

service-definition+xml

Produces

Deletes an E-LAN BGP service definition.

Output

Sample XML Output

Get an E-LAN Service Definition with Default Service Template By Definition ID

This request is used to retrieve the details of a particular E-LAN service definition with default service template, based on the service definition ID.

URI

api/space/nsas/elan-vpls/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-LAN service definition with default service template.

Output (E-LAN BGP)

Sample XML Output

Output (E-LAN LDP)

Sample XML Output

GET E-LAN Service Definition for vpls Instance and vpls Protocol Types

This request is used to retrieve the details of a particular E-LAN service definition with vpls as the instance and protocol type.

URL

/api/space/nsas/csd/service-definition/<definitionId>

Sample URL

https://192.0.2.10:8080/api/space/nsas/csd/service-definition/2134456

HTTP Method

GET

Accept Header

application/xml;

Content Type

application/xml;

Request

Not Applicable

Response

Create an E-LAN Service Definition with Default Service Template

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

URI

api/space/nsas/elan-vpls/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-LAN service definition configured with default service template.

Input (E-LAN BGP)

Sample XML Input

Input (E-LAN LDP)

Sample XML Input

Output

Sample XML Output

Create a Point-to-Multipoint E-LAN Service Definition (Version 2)

This request is used to create a point-to-multipoint E-LAN service definition in version 2 format. In the version 2 format, the <EnableRateLimiting> parameter is a mandatory parameter.

URI

api/space/nsas/elan-vpls/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-LAN service definition in version 2 format.

Input (E-LAN BGP)

Sample XML Input

Output

Sample XML Output

Modify an E-LAN Service Definition with vpls Instance and vpls Protocol Type

This request is used to modify an E-LAN Service Definition with vpls Instance and vpls Protocol Type.

URL

/api/space/nsas/csd/service-definition/<defn-id>

Sample URL

https://192.0.2.10:8080/api/space/nsas/csd/service-definition/12345

HTTP Method

POST

Accept Header

application/xml

Content Type

application/xml;

Request

Response