Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

IP Service Definitions Management RESTful Web Services

 

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

Get IP Service Definition Details with VRF Route Label By Definition ID

This request is used to retrieve the details of a particular IP service definition with VRF route label, based on the service definition ID.

URI

api/space/nsas/l3vpn/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 IP service definition with VRF route label.

Output

Sample XML Output

Get All Published IP Service Definitions

This request is used to retrieve all the published IP service definitions.

URI

All service types:

/api/space/nsas/service-management/

service-definitions/published

IP:

/api/space/nsas/l3vpn/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 IP service definitions.

Output

Sample XML Output

Create an IP Service Definition with VRF Route Label

This request is used to create an IP service definition with VRF route label.

URI

api/space/nsas/l3vpn/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 IP service definition with VRF route label.

Input

Sample XML Input

Output

Sample XML Output

Get All IP Service Definitions by Filter Criterion

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

URI

/api/space/nsas/l3vpn/service-management/service-

definitions?filteredby=State::Published

/api/space/nsas/l3vpn/service-management/service-

definitions?filteredby=Name::L3VPN

/api/space/nsas/l3vpn/service-management/service-

definitions?filteredby=ServiceType::L3 VPN (Full Mesh)

HTTP Method

GET

Consumes

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

service-definitions+xml;version=2

Produces

Collects all the configured Layer 3 service definitions that match the filter criteria

Note

For E-Line, IP, and E-LAN service definitions, the FilteredBy option can be Name, ServiceType, and State. For filtering based on the service type, you must specify the exact service type, such as inclusion of spaces for example: L3 VPN (Full Mesh)

Output

Sample XML Output

Create and Publish IP Service Definition

This request is used to create and publish an IP service definition.

URI

api/space/nsas/l3vpn/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 and publishes an IP service definition.

Output

Sample XML Output

Get E-Line Service Definition Details with Pseudowire Stitching for L3VPN By Definition ID

This request is used to retrieve the details of a particular E-Line service definition stitched to an L3VPN, 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 stitched to an L3VPN.

Output

Sample XML Output

Create an E-Line Service Definition with Pseudowire Stitching for L3VPN

This request is used to create an E-Line service definition with pseudowire stitching for an L3VPN.

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 service definition with pseudowire stitching for an L3VPN.

Input

Sample XML Input

Output

Sample XML Output

Create an IP Service Definition with Manual Route Distinguisher and Router Target

This request is used to create an IP service definition with manual route distinguisher and route target.

URI

api/space/nsas/l3vpn/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 IP service definition with manual route distinguisher and route target.

Input

Sample XML Input

Output

Sample XML Output

Get IP Service Definition Details with Manual Route Target By Definition ID

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

URI

api/space/nsas/l3vpn/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 IP service definition with manual route target..

Output

Sample XML Output

Get IP Service Definition Details with MC-LAG By Definition ID

This request is used to retrieve the details of a particular IP service definition with MC-LAG, based on the service definition ID.

URI

api/space/nsas/l3vpn/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 IP service definition with MC-LAG.

Output

Sample XML Output

Create an IP Service Definition

This request is used to create an IP service definition.

URI

api/space/nsas/l3vpn/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 IP service definition.

Input

Sample XML Input

Output

Sample XML Output

Publish and Unpublish an IP Service Definition

This request is used to publish or unpublish an IP service definition.

URI

api/space/nsas/l3vpn/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 IP 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 IP Service Definition

This request is used to delete a previously configured IP service definition.

URI

api/space/nsas/l3vpn/service-management/service-definitions/

<servicedefinition-id>

HTTP Method

DELETE

Consumes

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

service-definition+xml

Produces

Deletes an IP service definition.

Output

Sample XML Output

Get IP Service Definition Details with MC-LAG By Definition ID

This request is used to retrieve the details of a particular IP service definition with MC-LAG, based on the service definition ID.

URI

api/space/nsas/l3vpn/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 IP service definition with MC-LAG.

Output

Sample XML Output

Create an IP Service Definition with MC-LAG

This request is used to create an IP service definition with MC-LAG.

URI

api/space/nsas/l3vpn/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 IP service definition.

Input

Sample XML Input

Output

Sample XML Output

Get Full-Mesh IP Service Definition Details with Static Routing Protocol By Definition ID

This request is used to retrieve the details of a particular IP service definition with static routing protocol for full-mesh topology, based on the service definition ID.

URI

api/space/nsas/l3vpn/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 IP service definition with static routing protocol for full-mesh topology.

Output

Sample XML Output

Create a Full-Mesh IP Service Definition with Static Routing Protocol

This request is used to create an IP service definition with static routing protocol for full-mesh topology.

URI

api/space/nsas/l3vpn/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 IP service definition with static routing protocol for full-mesh topology.

Input

Sample XML Input

Output

Sample XML Output

Get a Hub-and-Spoke IP Service Definition Details with Static Routing Protocol By Definition ID

This request is used to retrieve the details of a particular IP service definition with static routing protocol for hub-and-spoke topology, based on the service definition ID.

URI

api/space/nsas/l3vpn/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 IP service definition with static routing protocol for hub-and-spoke topology.

Output

Sample XML Output

Create a Hub-and-Spoke IP Service Definition with Static Routing Protocol

This request is used to create an IP service definition with static routing protocol for hub-and-spoke topology.

URI

api/space/nsas/l3vpn/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 IP service definition with static routing protocol for hub-and-spoke topology.

Input

Sample XML Input

Output

Sample XML Output

Get an IP Service Definition with Default Service Template By Definition ID

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

URI

api/space/nsas/l3vpn/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 IP service definition with default service template.

Output (Full-Mesh IP)

Sample XML Output

Output (Hub-and-Spoke IP)

Sample XML Output

Create an IP Service Definition with Default Service Template

This request is used to create an IP service definition configured with default service template.

URI

api/space/nsas/l3vpn/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 IP service definition configured with default service template.

Input (Full-Mesh IP)

Sample XML Input

Input (Hub-and-Spoke IP)

Sample XML Input

Output

Sample XML Output