Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Provider Edge Device Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Provider Edge (PE) Devices Management RESTful Web Services.

Get All PE Devices

This request is used to collect all the PE devices.

URI

api/space/nsas/device-roles/pe-devices

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.device-roles.

pe-devices+xml

Produces

Retrieves all the PE devices that are managed and provisioned by the application.

Output

Sample XML Output

Get PE Devices By Device ID

This request is used to retrieve a PE device based on the device ID.

URI

api/space/nsas/device-roles/pe-devices/<pe-deviceID>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.device-roles.

pe-devices+xml

Produces

Retrieves the PE device based on the device ID.

Output

Sample XML Output

Get All Devices with Pagination, Search, and Filter

This request is used to collect all the device details with paging behavior applied on the output, and with the devices sorted and segregated depending on the search criteria.

URI

api/space/nsas/device-roles/pe-

devices?sortorder=desc&filteredby=name::space

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.device-roles.

pe-devices+xml;version=2

Produces

Retrieves the filtered list of devices with pagination, based on the search criteria

Note

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.

Output

Sample XML Output

Clear Interface Statistics

This request is used to clear the statistical information collected for the interfaces.

New Parameters

api/space/nsas/clear-interface-statistics

Description of the Changes

This API clears interface statistics of an interface.

URI

api/space/nsas/clear-interface-statistics

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-response+xml;version=2

application/vnd.juniper.api.space.nsas.clear-interface-statistics-

response+json;version=2

Content Type

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-request+json;version=2;charset=UTF-8

Produces

Clears the statistics of interfaces.

Input

Sample XML Input

Output

Sample XML Output

Perform an MPLS Ping for E-Line, IP, and E-LAN Services

This request is used to perform an MPLS ping operation for E-Line, IP, and E-LAN services.

New Parameters

/api/space/nsas/perform-mpls-ping

Description of the Changes

This API is used to perform an MPLS ping process.

URI

/api/space/nsas/perform-mpls-ping

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+xml;version=2

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+json;version=2"

Content Type

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+json;version=2;charset=UTF-8

Produces

Performs an MPLS ping operation for E-Line, IP, and E-LAN services.

Input

Sample XML Input

Output

Sample XML Output

Perform an MPLS Ping for LSPs

This request is used to perform an MPLS ping operation for LSPs.

New Parameters

/api/space/nsas/tunnels/perform-mpls-ping

Description of the Changes

This API is used to perform an MPLS ping process.

URI

/api/space/nsas/tunnels/perform-mpls-ping

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+xml;version=2

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+json;version=2"

Content Type

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+json;version=2;charset=UTF-8

Produces

Performs an MPLS ping operation for LSPs.

Input

Sample XML Input

Output

Sample XML Output

Get All Saved Configlets for a Device

This request is used to retrieve all the saved configlets for a particular device selected in Device view.

URI

/api/space/configuration-management/cli-configlets-

saved/<device-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.configuration-management.cli-

configlets+xml;version=3

Produces

Retrieves all the saved configlets for a particular device selected in Device view.

Input

Sample XML Input

Output

Sample XML Output

Get All Saved Configlets for a Template ID

This request is used to retrieve all the saved configlets for a particular template ID.

URI

/api/space/configuration-management/cli-configlets-

saved/<saved-template-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.configuration-management.cli-

configlets+xml;version=3

Produces

Retrieves all the saved configlets for a specific template ID.

Input

Sample XML Input

Output

Sample XML Output