Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-LAN Service Orders Management RESTful Web Services

 

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

Get All E-LAN BGP Service Orders

This request is used to retrieve all the configured Layer 2 Ethernet LAN (E-LAN) BGP service orders.

URI

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

HTTP Method

GET

Consumes

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

Produces

Collects all the configured E-LAN BGP service orders.

Output

Sample XML Output

Get All E-LAN Service Orders By Customer ID or Name

This request is used to retrieve all the configured Layer 2 Ethernet LAN (E-LAN) service orders based on customer name or customer ID.

URI

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

?customerId=1048781

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

?customerName=Customer_001

HTTP Method

GET

Consumes

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

service-orders+xml;version=2

Produces

Collects all the configured E-LAN BGP service orders based on the customer name or ID.

Output

Sample XML Output

Get All E-LAN Service Orders with Pagination, Search, and Filter

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

URI

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

?sortorder=asc&sortedby=Name&filteredby="Name::decomm"

HTTP Method

GET

Consumes

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

service-orders+xml;version=2

Produces

Collects all the configured E-LAN BGP service orders 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-LAN BGP Service Order By Order ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN (E-LAN) BGP service order based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

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

service-order+xml;version=2

Produces

Collects the details of a specific E-LAN BGP service order.

Output

Sample XML Output

Sample XML Output

Get an E-LAN LDP Service Order By Order ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN (E-LAN) LDP service order based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific E-LAN LDP service order.

Output

Sample XML Output

Get an E-LAN LDP Service Order By Order ID (Version 2)

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN (E-LAN) LDP service order based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml;version=2;

Produces

Collects the details of a specific E-LAN LDP service order.

Output

Sample XML Output

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

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

URI

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

<serviceOrder-Id>

HTTP Method

GET

Consumes

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

service-order+xml;version=2

Produces

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

Output

Sample XML Output

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

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

URI

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

<serviceOrder-Id>

HTTP Method

GET

Consumes

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

service-order+xml;version=2

Produces

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

Output

Sample XML Output

Get an E-LAN LDP Service Order By Order ID

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

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

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

service-order+xml;version=2;

Produces

Collects the details of a specific E-LAN LDP service order.

Output (Version 1)

Sample XML Output

Output (Version 2)

Sample XML Output

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

This request is used to retrieve the details of a particular E-LAN service order with evpn as the instance type.

URL

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

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/service-orders/paging/917504

HTTP Method

GET

Accept Type

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

Content Type

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

Response

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

This request is used to retrieve the details of a particular E-LAN service order with evpn e-tree as the protocol type.

URL

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

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/service-orders/paging/917504

HTTP Method

GET

Accept Type

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

Content Type

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

Response

Create an E-LAN BGP Service Order (Version 1)

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Creates an E-LAN BGP service order.

Input (VLAN Normalization: Normalize to QinQ tags for Full-Mesh VPLS)

Sample XML Input

Input (VLAN Normalization: Normalize to QinQ tags for Hub-and-Spoke VPLS)

Sample XML Input

Output

Sample XML Output

Create an E-LAN BGP Service Order (Version 2)

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

URI

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

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Creates an E-LAN BGP service order.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN LDP Service Order (Version 1)

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates an E-LAN LDP service order.

Input (Full-Mesh IP)

Sample XML Input

Output (Full-Mesh IP)

Sample XML Output

Input (Hub-and-Spoke IP)

Sample XML Input

Output (Hub-and-Spoke IP)

Sample XML Output

Create an E-LAN LDP Service Order (Version 2)

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

URI

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

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Creates an E-LAN LDP service order.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN Service Order with evpn as the Instance Type

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

URL

/api/space/nsas/csd/service-order

Sample URL

https://192.0.2.10:8443/api/space/nsas/csd/service-order

HTTP Method

POST

Accept Header

application/xml

Content Type

application/xml

Input

Sample XML Input

Create an E-LAN Service Order with evpn e-tree as the Protocol Type

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

URL

/api/space/nsas/csd/service-order

Sample URL

https://192.0.2.10:8443/api/space/nsas/csd/service-order

HTTP Method

POST

Accept Header

application/xml

Content Type

application/xml

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN Service Order with virtual-switch as the Instance Type and VPLS as the Protocol Type

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

URL

/api/space/nsas/csd/service-order

Sample URL

https://192.0.2.10:8443/api/space/nsas/csd/service-order

HTTP Method

POST

Accept Header

application/xml

Content Type

application/xml

Input

Response

Deploy, Validate, and Partially-Delete an E-LAN BGP Service Order

This request is used to deploy, validate, or partially delete a previously created E-LAN BGP service order.

URI

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

HTTP Method

POST

Content-Type

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

Consumes

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

service-order-status+xml

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

  • DeployNow (Deploy an already created SO)

  • DeployLater (Deploy Later an already created SO)

  • ValidateNow (Validate now an already created SO)

  • ValidateLater (Validate later an already created SO)

  • PartialDeleteNow (Delete the partially created configuration now)

  • PartialDeleteLater (Delete the partially created configuration Later

Produces

Deploys, validates or, partially-deletes a previously created E-LAN BGP service order.

Input

Sample XML Input

Output

Sample XML Output

Delete an E-LAN BGP Service Order

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

URI

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

<serviceOrder-id>

HTTP Method

DELETE

Consumes

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

Produces

Deletes an E-LAN BGP service order.

Output

Sample XML Output

View the Pending Configuration of an E-LAN Service Order

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

URI

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

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 order pending to be applied to a device.

Output

Sample XML Output

Get an E-LAN Service Order with Manual Route Target By Order ID

This request is used to retrieve the details of a particular Layer 2 Ethernet LAN (E-LAN) BGP service order with manual route target based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific E-LAN service order with manual route target.

Output

Sample XML Output

Create an E-LAN Service Order with Manual Route Target

This request is used to create an E-LAN service order configured with manual route target.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates an E-LAN service order with manual route target.

Input

Sample XML Input

Output

Sample XML Output

Get a Multipoint-to-Multipoint E-LAN BGP Service Order with Manual Route Target By Order ID

This request is used to retrieve the details of a particular multipoint-to-multipoint E-LAN BGP service order with manual route target based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific multipoint-to-multipoint E-LAN BGP service order with manual route target.

Output

Sample XML Output

Get a Point-to-Multipoint E-LAN BGP Service Order with Manual Route Target By Order ID

This request is used to retrieve the details of a particular point-to-multipoint E-LAN BGP service order with manual route target based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with manual route target.

Output

Sample XML Output

Get a Multipoint-to-Multipoint E-LAN LDP Service Order with Manual Route Target By Order ID

This request is used to retrieve the details of a particular multipoint-to-multipoint E-LAN LDP service order with manual route target based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific multipoint-to-multipoint E-LAN LDP service order with manual route target.

Output

Sample XML Output

Get a Point-to-Multipoint E-LAN BGP Service Order with Manual Route Target By Order ID

This request is used to retrieve the details of a particular point-to-multipoint E-LAN BGP service order with manual route target based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with manual route target.

Output

Sample XML Output

Create a Multipoint-to-Multipoint E-LAN LDP Service Order with Manual Route Target

This request is used to create a multipoint-to-multipoint E-LAN LDP service order configured with manual route target.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a multipoint-to-multipoint E-LAN LDP service order with manual route target.

Input

Sample XML Input

Create a Point-to-Multipoint E-LAN LDP Service Order with Manual Route Target

This request is used to create a point-to-multipoint E-LAN LDP service order configured with manual route target.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN LDP service order with manual route target.

Input

Sample XML Input

Create a Point-to-Multipoint E-LAN BGP Service Order with Manual Route Target

This request is used to create a point-to-multipoint E-LAN BGP service order configured with manual route target.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN BGP service order with manual route target.

Input

Sample XML Input

Create a Multipoint-to-Multipoint E-LAN BGP Service Order with Manual Route Target

This request is used to create a multipoint-to-multipoint E-LAN BGP service order configured with manual route target.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a multipoint-to-multipoint E-LAN BGP service order with manual route target.

Input

Sample XML Input

Note

Starting with Connectivity Services Director Release 1.0R1, the tag names for specifying the auto-pick route target option are modified as follows:

<RouteTarget_AutoPick>true</RouteTarget_AutoPick>

<RouteTarget_AutoPick>false</RouteTarget_AutoPick>

In Services Activation Director, this tag was named as <RouteTarget AutoPick>.

If you are migrating from Services Activation Director to Connectivity Services Director and if your E-LAN service orders contain the auto-pick route target setting, you need to examine such service orders and use the updated tag names when you create an E-LAN service order using a REST API request..

Get a Multipoint-to-Multipoint E-LAN BGP Service Order with Tag Protocol ID By Order ID

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

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific multipoint-to-multipoint E-LAN BGP service order with tag protocol ID.

Output

Sample XML Output

Get a Point-to-Multipoint E-LAN BGP Service Order with Tag Protocol ID By Order ID

This request is used to retrieve the details of a particular point-to-multipoint E-LAN BGP service order with tag protocol ID based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with tag protocol ID.

Output

Sample XML Output

Get a Multipoint-to-Multipoint E-LAN LDP Service Order with Tag Protocol ID By Order ID

This request is used to retrieve the details of a particular multipoint-to-multipoint E-LAN LDP service order with tag protocol ID based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific multipoint-to-multipoint E-LAN LDP service order with tag protocol ID.

Output

Sample XML Output

Get a Point-to-Multipoint E-LAN BGP Service Order with Tag Protocol ID By Order ID

This request is used to retrieve the details of a particular point-to-multipoint E-LAN BGP service order with tag protocol ID based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with tag protocol ID.

Output

Sample XML Output

Create a Multipoint-to-Multipoint E-LAN LDP Service Order with Tag Protocol ID

This request is used to create a multipoint-to-multipoint E-LAN LDP service order configured with tag protocol ID.

URI

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

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a multipoint-to-multipoint E-LAN LDP service order with tag protocol ID.

Input

Sample XML Input

Create a Point-to-Multipoint E-LAN LDP Service Order with Tag Protocol ID

This request is used to create a point-to-multipoint E-LAN LDP service order configured with tag protocol ID.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN LDP service order with tag protocol ID.

Input

Sample XML Input

Create a Point-to-Multipoint E-LAN BGP Service Order with Tag Protocol ID

This request is used to create a point-to-multipoint E-LAN BGP service order configured with tag protocol ID.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN BGP service order with tag protocol ID.

Input

Sample XML Input

Create a Multipoint-to-Multipoint E-LAN BGP Service Order with Tag Protocol ID

This request is used to create a multipoint-to-multipoint E-LAN BGP service order configured with tag protocol ID.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a multipoint-to-multipoint E-LAN BGP service order with tag protocol ID.

Input

Sample XML Input

Note

Starting with Connectivity Services Director Release 1.0R1, the tag names for specifying the auto-pick route target option are modified as follows:

<RouteTarget_AutoPick>true</RouteTarget_AutoPick>

<RouteTarget_AutoPick>false</RouteTarget_AutoPick>

In Services Activation Director, this tag was named as <RouteTarget AutoPick>.

If you are migrating from Services Activation Director to Connectivity Services Director and if your E-LAN service orders contain the auto-pick route target setting, you need to examine such service orders and use the updated tag names when you create an E-LAN service order using a REST API request..

Create a Point-to-Multipoint E-LAN LDP Service Order with Pseudowire Redundancy

This request is used to create a point-to-multipoint E-LAN LDP service order configured with pseudowire redundancy.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN LDP service order with pseudowire redundancy.

Input

Sample XML Input

Output

Sample XML Output

Create a Point-to-Multipoint E-LAN BGP Service Order with Pseudowire Redundancy

This request is used to create a point-to-multipoint E-LAN BGP service order configured with pseudowire redundancy.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN BGP service order with pseudowire redundancy.

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific point-to-multipoint E-LAN LDP service order with pseudowire redundancy.

Output

Sample XML Output

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

This request is used to retrieve the details of a particular point-to-multipoint E-LAN BGP service order with pseudowire redundancy based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with pseudowire redundancy.

Output

Sample XML Output

Create a Point-to-Multipoint E-LAN LDP Service Order with Pseudowire Stitching

This request is used to create a point-to-multipoint E-LAN LDP service order configured with pseudowire stitching.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN LDP service order with pseudowire stitching.

Input

Sample XML Input

Create a Point-to-Multipoint E-LAN BGP Service Order with Pseudowire Stitching

This request is used to create a point-to-multipoint E-LAN BGP service order configured with pseudowire stitching.

URI

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

redundancy

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Creates a point-to-multipoint E-LAN BGP service order with pseudowire stitching.

Input

Sample XML Input

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

This request is used to retrieve the details of a particular point-to-multipoint E-LAN LDP service order with pseudowire stitching based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN LDP service order with pseudowire stitching.

Output

Sample XML Output

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

This request is used to retrieve the details of a point-to-multipoint E-LAN BGP service order with pseudowire stitching based on the service order ID.

URI

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

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific point-to-multipoint E-LAN BGP service order with pseudowire stitching.

Output

Sample XML Output

Modify a Saved E-LAN Service Order with LDP

This request is used to modify a saved E-LAN LDP service order.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Modifies a saved E-LAN LDP service order.

Input

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN Service Order with LDP (Version 2)

This request is used to modify a saved E-LAN service order with LDP.

URI

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

<serviceOrderId>

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

Modifies a saved E-LAN service order with LDP.

Input

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN Service Order with BGP

This request is used to modify a saved E-LAN BGP service order.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Modifies a saved E-LAN BGP service order.

Input

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN Service Order with BGP (Version 2)

This request is used to modify a saved E-LAN service order with BGP.

URI

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

<serviceOrderId>

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

Modifies a saved E-LAN service order with BGP.

Input

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN BGP Service Order with Ethernet Option as Asymmetric Tag Depth

This request is used to modify a saved E-LAN BGP service order configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Modifies a saved E-LAN BGP service order configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option.

Input (Ethernet LDP)

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN BGP Service Order with Static Pseudowires

This request is used to modify a saved E-LAN BGP service order configured with static pseudowires.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Modifies a saved E-LAN BGP service order with static pseudowires.

Input

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN BGP Service Order with Multisegment Pseudowires

This request is used to modify a saved E-LAN BGP service order configured with multisegment pseudowires.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.

service-order+xml

Consumes

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

service-order-status+xml

Produces

Modifies a saved E-LAN BGP service order with multisegment pseudowires.

Input (Ethernet LDP)

Sample XML Input

Output

Sample XML Output

Modify a Saved E-LAN BGP Service Order with MC-LAG Interfaces

This request is used to modify a saved E-LAN BGP service order configured with MC-LAG interfaces.

URI

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

<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.service-order+xml

Consumes

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

service-order-status+xml

Produces

Modifies a saved E-LAN BGP service order with MC-LAG interfaces.

Input (Ethernet LDP)

Sample XML Input

Output

Sample XML Output

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

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

URI

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

<serviceorder-Id>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific E-LAN service order with default service template.

Output (E-LAN BGP)

Sample XML Output

Create an E-LAN Service Order with Default Service Template

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

URI

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

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

Input (E-LAN BGP)

Sample XML Input

Sample XML Input (With XPath)

Input (E-LAN LDP)

Sample XML Input

Sample XML Input (With XPath)

Output

Sample XML Output

Modify an E-LAN Service Order with Default Service Template

This request is used to modify an E-LAN service order configured with default service template.

URI

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

HTTP Method

POST

Content-Type

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

management.

modify-service-order+xml; version=2;charset=UTF-8

Consumes

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

service-order-status+xml; version=2

Produces

Modifies an E-LAN service order configured with default service template.

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

Input (E-LAN BGP)

Sample XML Input

Sample XMLInput (With XPath)

Input (E-LAN LDP)

Sample XML Input

Sample XMLInput (With XPath)

Output

Sample XML Output

Get Job Details By Job ID for an E-LAN Service Order

This request is used to obtain the details of a specific job, based on its unique identifier.

New Parameters

"getJobDetailsForRequest”

Description of the Changes

"This API is to display the job details as a device view. Previously, the job summary was shown when you double-clicked the link in a job ID. With this new REST API call, job details are filtered on the basis of each device.

HTTP Method

GET

URI

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

management/service-orders/jobId

Consumes

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

management.service-orders+json;version=2

Produces

Retrieves the details of a particular job.

Mandatory Parameters

jobID

Output

Sample JSONOutput

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

This request is used to create a point-to-multipoint E-LAN BGP service order in version 2 format.

Note

If you are using a point-to-point spoke, you must not include the <BackupNeighbourHub> tag. Also, the following parameters are mandatory when you create a service order in version 2 format:

<RouteDistinguisher AutoPick= "true/false"></RouteDistinguisher>

<HubRouteTarget AutoPick = "true/false"></HubRouteTarget>

<SpokeRouteTarget AutoPick = "true/false"></SpokeRouteTarget>

<RouteTarget AutoPick ="true/false"></RouteTarget>

<RouteTarget_AutoPick>true/false</RouteTarget_AutoPick>

URI

api/space/nsas/elan-vpls/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 point-to-multipoint E-LAN BGP service order.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN Service Order to Create an LSP

This request is used to create an E-LAN service order for creating an LSP.

URL

/api/space/nsas/csd/service-order

HTTP Method

POST

Sample URL

https://192.0.2.10:8443/api/space/nsas/csd/service-order

Accept Header

application/xml

Content Type

application/xml

Input

Sample XML Input

Output

Sample XML Output

Get an E-LAN Service Order to Create an LSP

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

URL

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

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/service-orders/paging/196608

Accept

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

Content Type

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

Input

Not Applicable

Output

Sample XML Output

Create an E-LAN Service Order to Associate an LSP

This request is used to create an E-LAN service order for associating it with an LSP.

URL

/api/space/nsas/csd/service-order

HTTP Method

POST

Sample URL

https://192.0.2.10:8443/api/space/nsas/csd/service-order

Accept Header

application/xml

Content Type

application/xml

Input

Sample XML Input

Response

Get an E-LAN Service Order to Associate an LSP

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

URL

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

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/elan-vpls/service-management/service-orders/paging/196608

Accept

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

Content Type

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

Input

Not Applicable

Output

Sample XML Output