Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-Line BGP Service Orders Management RESTful Web Services

 

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

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

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

URI

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

Output

Sample XML Output

Get E-Line 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 Private Line (EPL, also called E-Line) BGP service order with burst size calculation based on the service order ID.

URI

api/space/nsas/eline-ptp/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-Line BGP service order with burst size calculation.

Output

Sample XML Output

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

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

URI

api/space/nsas/eline-ptp/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-Line service order configured with normalization of VLANs and logical unit of interfaces.

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

Sample XML Output

Output (VLAN Normalization: Normalize to dot1Q tags)

Sample XML Output

Get E-Line Service Order with BGP (Version 2)

This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) service order configured with signaling as BGP.

URI

/api/space/nsas/eline-ptp/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-Line service order with BGP signaling.

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

Sample XML Output

Output

Sample XML Output

Create an Ethernet, ATM, or TDM BGP Service Order

This request is used to create a BGP service order with Ethernet, ATM, or TDM interfaces.

URI

/api/space/nsas/eline-ptp/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;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 a BGP service order with Ethernet, ATM, and TDM interfaces.

Input (Ethernet BGP)

Sample XML Input

Input (ATM BGP)

Sample XML Input

Input (TDM BGP)

Sample XML Input

Output

Sample XML Output

Create an E-Line BGP Service Order

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

URI

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

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line BGP Service Order with Instance Type as evpn-vpws

This request is used to create an E-Line BGP service order with instance type as evpn-vpws.

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

Request

Response

Create an E-Line BGP Service Order with Manual Route Distinguisher and Route Target

This request is used to create an E-Line BGP service order with manually-configured route distiguisher and route target attributes.

URI

api/space/nsas/eline-ptp/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-Line BGP service order with manually-configured route distiguisher and route target attributes.

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line BGP Service Order with Pseudowire Redundancy

This request is used to create an E-Line BGP service order configured with pseudowire redundancy.

URI

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

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line BGP Service Order By Order ID

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

URI

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

Output

Sample XML Output

Get All E-Line BGP Service Orders

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

URI

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

HTTP Method

GET

Consumes

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

Produces

Collects all the configured E-Line BGP service orders.

Output

Sample XML Output

Create an E-Line BGP Service Order with Static Pseudowire for E-Line

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

URI

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

Input

Sample XML Input

Output

Sample XML Output

GET E-Line Service Order with Instance Type as evpn-vpws

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) BGP service orders with instance type as evpn-vpws.

URL

/api/space/nsas/eline-ptp/service-management/service-orders/<id>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/eline-ptp/service-management/service-orders/1114112

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;

Request

Not Applicable

Response

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

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

URI

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

Input

Sample XML Input

Output

Sample XML Output

Delete an E-Line BGP Service Order

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

URI

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

service-orders/<serviceOrder-id>

HTTP Method

DELETE

Consumes

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

service-order+xml

Produces

Deletes an E-Line BGP service order.

Output

Sample XML Output

View the Pending Configuration of an E-Line Service Order

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

URI

api/space/nsas/eline-ptp/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-Line BGP Service Order with Tag Protocol ID By Order ID

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

URI

api/space/nsas/eline-ptp/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-Line BGP service order with tag protocol ID.

Output

Sample XML Output

Create an E-Line BGP Service Order with Tag Protocol ID

This request is used to create an E-Line BGP service order configured with tag protocol ID.

URI

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

service-orders/{service-order-id}

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-Line BGP service order with tag protocol ID.

Input

Sample XML Input

Modify a Saved E-Line Service Order with BGP

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

URI

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

service-orders/<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.modify-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-Line BGP service order.

Input (Ethernet - BGP)

Sample XML Input

Output

Sample XML Output

Input (TDM–BGP)

Sample XML Input

Output (TDM–BGP)

Sample XML Output

Input (ATM–BGP)

Sample XML Input

Output (ATM–BGP)

Sample XML Output

Modify a Saved E-Line Service Order (Version 2)

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

URI

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

service-orders/<serviceOrderId>

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 a saved E-Line service order.

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

service-orders/<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.modify-service-order+xml

Consumes

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

service-order-status+xml

Produces

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

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

service-orders/<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.modify-service-order+xml

Consumes

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

service-order-status+xml

Produces

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

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

service-orders/<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.modify-service-order+xml

Consumes

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

service-order-status+xml

Produces

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

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

service-orders/<serviceOrderId>

HTTP Method

POST

Content-Type

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

management.modify-service-order+xml

Consumes

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

service-order-status+xml

Produces

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

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line BGP Service Order with Default Service Template By Order ID

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

URI

api/space/nsas/eline-ptp/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-Line BGP service order with default service template.

Output

Sample XML Output

Create an E-Line BGP Service Order with Default Service Template

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

URI

api/space/nsas/eline-ptp/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-Line BGP service order configured with default service template.

Input

Sample XML Input

Output

Sample XML Output

Modify an E-Line BGP Service Order with Default Service Template

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

URI

api/space/nsas/eline-ptp/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-Line BGP 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

Sample XML Input

Sample XML Input (With XPath)

Output

Sample XML Output

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

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

URI

/api/space/nsas/elan-ptp/service-

management/service-orders/jobId

HTTP Method

GET

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 an E-Line BGP Service Order to Create an LSP

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

URL

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

HTTP Method

POST

Sample URL

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

Accept Header

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

Content Type

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

Request

Response

Get an E-Line BGP Service Order to Associate an LSP

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

URL

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

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/eline-ptp/service-management/service-orders/131073

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;

Request

Not Applicable

Response