Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

E-Line BGP Service Definitions 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 All E-Line BGP Service Definitions with Pagination, Search, and Filter

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

URI

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

service-definitions?start=4&limit=2

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

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

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

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

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

URI

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

definitions?filteredby=State::unPublished

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

definitions?filteredby=Name::CreateP2PSD01

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

definitions?filteredby=ServiceType::P2P(ETHERNET)

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

definitions?filteredby=Signaling::LDP

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

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

Note

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

Output

Sample XML Output

Get All Published E-Line Service Definitions

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

URI

All service types:

/api/space/nsas/service-management/

service-definitions/published

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

service-definitions/published

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Content Type

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

service-definitions+xml;charset=UTF-8

Produces

Collects all the published E-Line service definitions.

GET an E-Line BGP Service Definition with Instance Type as evpn-vpws

This request is used to retrieve all the E-Line service definitions with instance type as evpn-vpws.

URL

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

HTTP Method

GET

Sample URL

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

Accept

application/xml;

Content Type

application/xml;

Input

Not Applicable

Output

Sample XML Output

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

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml;version=2;charset=UTF-8

Consumes

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

Produces

Creates an E-Line BGP service definition configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option

Input

Sample XML Input

Output

Sample XML Output

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

This request is used to create an E-Line BGP service definition configured with manual route distinguisher and route target attributes.

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml;version=2;charset=UTF-8

Consumes

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

service-definition-status+xml;version=2

Produces

Creates an E-Line BGP service definition configured with manual route distinguisher and route target attributes.

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line BGP Service Definition with Ethernet Interfaces

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

URI

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

service-definitions/

HTTP Method

POST

Content-Type

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

management.service-definition+xml

Consumes

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

service-definition-status+xml

Produces

Creates an E-Line BGP service definition configured with interfaces that contain Ethernet encapsulation.

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line BGP Service Definition with ATM Interfaces

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml

Consumes

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

service-definition-status+xml

Produces

Creates an E-Line BGP service definition configured with ATM interfaces.

Input

Sample XML Input

Create an E-Line BGP Service Definition with TDM Interfaces

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml

Consumes

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

service-definition-status+xml

Produces

Creates an E-Line BGP service definition configured with TDM interfaces.

Input

Sample XML Input

Create an E-Line Service Definition

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml;version=2;charset=UTF-8

Consumes

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

service-definition-status+xml;version=2

Produces

Creates an E-Line service definition.

Input

Sample XML Input

Output

Sample XML Output

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

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

URL

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

HTTP Method

POST

Sample URL

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

Accept Header

application/xml

Content Type

application/xml;

Input

Sample XML Input

Output

Sample XML Output

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

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

URI

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

<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml

Produces

Collects the details of a specific E-Line BGP service definition with manually-configured route distinguisher and route target parameters.

Output

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml;version=2

Produces

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

Output (VLAN Normalization: Normalize to dot1Q tags)

Sample XML Output

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

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

URI

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

service-definitions/<servicedefinition-Id>

HTTP Method

GET

Consumes

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

service-definition+xml

Produces

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

Output

Sample XML Output

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

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

URI

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

HTTP Method

POST

Content-Type

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

management.service-definition+xml;version=2;charset=UTF-8

Consumes

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

service-definition-status+xml;version=2

Produces

Creates an E-Line BGP service definition configured with default service template.

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

Input

Sample XML Input

Sample XML Input (With XPath)

Output

Sample XML Output