Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-LAN Services Management RESTful Web Services

 

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

Get an E-LAN BGP Service By Service ID

This request is used to retrieve the details of a particular E-LAN BGP service.

URI

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

Output

Sample XML Output

Get an E-LAN LDP Service By Service ID

This request is used to retrieve the details of a particular E-LAN LDP service.

URI

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

Output

Sample XML Output

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

This request is used to retrieve the details of a particular E-LAN BGP service pseudowire stitching.

URI

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

Output

Sample XML Output

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

This request is used to retrieve the details of a particular E-LAN LDP service pseudowire stitching.

URI

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

Output

Sample XML Output

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

This request is used to retrieve the details of a particular E-LAN BGP service with burst size calculation based on the service ID.

URI

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

services/<serviceId>

HTTP Method

GET

Consumes

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

services+xml;version=2

Produces

Collects the details of a specific E-LAN BGP service with burst size calculation.

Output

Sample XML Output

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

This request is used to retrieve the details of a particular E-LAN LDP service with burst size calculation based on the service ID.

URI

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

services/<serviceId>

HTTP Method

GET

Consumes

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

services+xml;version=2

Produces

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

Output

Sample XML Output

Get an E-LAN BGP Point-to-Multipoint Service with Pseudowire Redundancy By Service ID

This request is used to retrieve the details of a particular E-LAN BGP service pseudowire redundancy.

URI

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

Output

Sample XML Output

Get an E-LAN LDP Point-to-Multipoint Service with Pseudowire Redundancy By Service ID

This request is used to retrieve the details of a particular E-LAN LDP service pseudowire redundancy.

URI

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

Output

Sample XML Output

Get an E-LAN BGP Service with Manual Route Distinguisher and Route Target By Service ID

This request is used to retrieve the details of a particular E-LAN BGP service with manually-configured route distinguisher and route target.

URI

api/space/nsas/elan-vpls/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-LAN BGP service with manually-configured route distinguisher and route target.

Output

Sample XML Output

GET an E-LAN Service With evpn e-tree as the Protocol Type

This request is used to retrieve an E-LAN service with evpn e-tree as the protocol type.

URL

/api/space/nsas/elan-vpls/service-management/services/paging/<service id>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/services/paging/786434

Accept

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

Content Type

Not Applicable

Request

Not Applicable

Response

GET an E-LAN Service with evpn as the Instance Type

This request is used to retrieve an E-LAN service with evpn as the instance type.

URL

/api/space/nsas/elan-vpls/service-management/services/paging//api/space/nsas/elan-vpls/service-management/services/paging/<service id>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/services/paging/786434

Accept

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

Content Type

Not Applicable

Request

Not Applicable

Response

GET an E-LAN Service With virtual-switch as the Instance Type

This request is used to retrieve an E-LAN service with virtual-switch as the instance type.

URL

/api/space/nsas/elan-vpls/service-management/services/paging/<service id>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/services/paging/786434

Accept

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

Content Type

Not Applicable

Request

Not Applicable

Response

Modify an E-LAN BGP Service with Pseudowire Redundancy

This request is used to modify an E-LAN BGP service with pseudowire redundancy.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Modify an E-LAN BGP Service with Addition of a Site

This request is used to modify an E-LAN BGP service with addition of a site.

URI

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

{service-Id}/add-sites

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-LAN BGP service with addition of a site.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-LAN BGP Service with Updates to an Existing Site Parameters

This request is used to modify an E-LAN BGP service with updates to an already existing endpoint or site.

URI

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

{service-Id}/

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

Produces

Modifies an E-LAN BGP service with updates to an already existing endpoint or site.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-LAN BGP Service with Deletion of a Site

This request is used to modify an E-LAN BGP service with deletion of a site.

URI

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

{service-Id}/delete-sites

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

Produces

Modifies an E-LAN BGP service with deletion of a site.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-LAN BGP Service for Service Name and Endpoint Details

This request is used to modify an E-LAN BGP service for service name and endpoint information.

URI

api/space/nsas/elan-vpls/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-LAN BGP service with updates to service name and endpoint details.

Input

Sample XML Input

Output

Sample XML Output

Get All E-LAN BGP Services

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

URI

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

HTTP Method

GET

Consumes

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

Produces

Collects all the configured E-LAN BGP services.

Output

Sample XML Output

Get All E-LAN BGP 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/elan-vpls/service-management/services

?customerId=360448

api/space/nsas/elan-vpls/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-LAN BGP services based on the customer name or ID.

Output

Sample XML Output

Get E-LAN BGP Service Details By Service ID

This request is used to retrieve the details of a particular E-LAN BGP service based on the service ID.

URI

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

Output (Version 2)

Sample XML Output

Force-Deploy an E-LAN BGP Service

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

URI

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

Input

Sample XML Input

Output

Sample XML Output

Bulk Force-Deploy an E-LAN Service

This request is used to forcibly deploy previously created services in a bulk operation.

URI

api/space/nsas/elan-vpls/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 previously created services in a bulk operation.

Input (Bulk Force-Deploy Immediately)

Sample XML Input

Input (Bulk Force-Deploy Later)

Sample XML Input

Output

Sample XML Output

Bulk Decommission E-LAN Services

This request is used to decommission previously created services in a bulk operation..

URI

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

Performs a single-step, wholesale decommissioning of previously created services.

Input (Bulk Decommission Immediately)

Sample XML Input

Input (Bulk Decommission Later)

Sample XML Input

Output

Sample XML Output

Decommission an E-LAN BGP Service Immediately

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

URI

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

services/{serviceId}

HTTP Method

DELETE

Content-Type

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

service+xml

Produces

Decommissions a previously created E-LAN BGP service immediately.

Input

Sample XML Input

Output

Sample XML Output

Get E-LAN Service Details with Endpoints Paginated

This request is used to get E-LAN service details with endpoints paginated.

URI

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

services/paging

HTTP Method

GET

Content-Type

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

service+xml

Produces

Gets E-LAN BGP service details..

Output

Sample XML Output

Submit modified E-LAN Service

This request submits modified E-LAN service.

URI

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

services/1869230/update-sites

HTTP Method

SUBMIT

Content-Type

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

service+xml

Produces

Submits modified E-LAN service.

Input

Sample XML Intput

Output

Sample XML Output

Get an E-LAN Service Definition to Create an LSP

This request is used to retrieve an E-LAN service definition for creating an LSP.

URL

/api/space/nsas/elan-vpls/service-management/services/paging/<orderID>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/services/paging/163840

Accept

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

Content Type

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

Request

Not Applicable

Response

Get an E-LAN Service to Associate an LSP

This request is used to retrieve an E-LAN service for associating an LSP.

URL

/api/space/nsas/elan-vpls/service-management/services/paging/<orderID>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/services/paging/163840

Accept

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

Content Type

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

Request

Not Applicable

Response