Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Resource Pools Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Resource Pools Management RESTful Web Services.

Get Status of Resource Pools for a VLAN

This request is used to retrieve the status of resource pools for a VLAN interface. While creating service order, there is a possibility that you might enter an already allocated VLAN ID. To identify whether a particular VLAN ID is already allocated or nota resource pool API has been designed. The interface ID for a particular interface in a device is found by using the following API:

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

URI

api/space/nsas/resource-utilization/vlan-resource/

<interface-id>/<vlan-id>

HTTP Method

GET

Consumes

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

utilization.vlan-resource-status+xml

Produces

Displays the status of resource pools for a VLAN ID.

Output

Sample XML Output

Get Status of Resource Pools for a Virtual Circuit

This request is used to retrieve the status of resource pools for a virtual circuit. The interface ID for a particular interface in a device is found by using the following API:

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

URI

api/space/nsas/resource-utilization/

vc-resource/<vc-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.

resource-utilization.vc-resource-status+xml

Produces

Displays the status of resource pools for a virtual circuit.

Output

Sample XML Output

Get Status of Route Distinguishers in Resource Pools

This request is used to retrieve the status of route distinguishers (RDs) in a resource pool. The device ID for a particular device is found by using the following API:

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

URI

api/space/nsas/resource-utilization/

rd-resource/<deviceId>/<rdValue>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.

resource-utilization.rd-resource-status+xml

Produces

Displays the status of route distinguishers in a resource pool.

Output

Sample XML Output

Get Status of Route Targets in Resource Pools

This request is used to retrieve the status of route targets (RTs) in a resource pool. The device ID for a particular device is found by using the following API:

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

URI

api/space/nsas/resource-utilization/rd-resource/

<deviceId>/<rtValue>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.resource-utilization.

rt-resource-status+xml

Produces

Displays the status of route targets in a resource pool.

Output

Sample XML Output

Get All Resource Pools Available in Junos Space

This request is used to retrieve the configured resource pool details.

URI

api/space/nsas/resource-utilization/resource-pools

HTTP Method

GET

Consumes

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

utilization.resource-pools+xml

Produces

Collects all the resource pool details available in Junos Space.

Output

Sample XML Output

Get Allocated Resources for a Pool

This request is used to retrieve all the allocated resources for a particular pool.

URI

api/space/nsas/resource-utilization/resource-pools

/pool-id

HTTP Method

GET

Consumes

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

utilization.resource-pools+xml

Produces

Collects all the allocated resources for a particular pool.

Output

Sample XML Output

Get Status of Units in Resource Pools for IPv4 Address Profiles

This request is used to retrieve the status of units for interfaces in a resource pool. While creating a service order, there is a possibility that you might configure an already allocated unit. To find out whether a particular unit has been previously allocated, the Resource Pool API has been implemented. The interface ID for a particular interface in a device can be determined by using the following API:

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

URI

api/space/nsas/resource-utilization/unit-

resource/{interface-id}/{unit}

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.

resource-utilization.unit-resource-status+xml

Produces

Displays the status of units in a resource pool.

Output

Sample XML Output

Get All Resource Pools for IPv4 Address Profiles

This request is used to retrieve the configured IPv4 address resource pool details.

URI

api/space/nsas/resource-utilization/ipv4address-pool

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.resource-utilization.

ipv4address-pools+xml

Produces

Collects all the IPv4 address resource pool details.

Output

Sample XML Output

Get IPv4 Address Resource Pools By Pool ID

This request is used to retrieve the details of a specific resource pool based on the pool identifier.

URI

api/space/nsas/resource-utilization/

ipv4address-pool/<poolId>

HTTP Method

GET

Consumes

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

utilization.ipv4address-pool+xml

Produces

Collects a specific IPv4 address resource pool details.

Output

Sample XML Output

Get All Resource Pools

This request is used to retrieve the configured resource pool details.

URI

api/space/nsas/resource-utilization/resource-pools?

start=<start count>&limit=<number for records>

HTTP Method

GET

Consumes

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

utilization.resource-pools+xml

Produces

Collects all the resource pool details.

Output

Sample XML Output

Get Allocated Resource Pools By Pool ID

This request is used to retrieve the details of a specific allocated resource pool based on the pool identifier.

URI

api/space/nsas/resource-utilization/

resource-pool/<poolId>

HTTP Method

GET

Consumes

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

utilization.resource-pool+xml

Produces

Collects a specific allocated resource pool details.

Output

Sample XML Output

Create an IPv4 Resource Pool

This request is used to create an IPv4 resource pool.

URI

api/space/nsas/resource-utilization/ipv4address-pool

HTTP Method

POST

Content-Type

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

utilization.ipv4address-pool+xml

Consumes

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

utilization.ipv4address-pool-status+xml

Produces

Creates an IPv4 resource pool.

Input for Creating a Global Pool

Sample XML Input for Creating a Global Pool

Input for Creating a Customer Pool

Sample XML Input for Creating a Customer Pool

Output

Sample XML Output

Delete an IPv4 Resource Pool

This request is used to delete a previously configured IPv4 resource pool.

URI

api/space/nsas/resource-utilization/ipv4address-pool

HTTP Method

DELETE

Consumes

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

utilization.ipv4address-pool-status+xml

Produces

Deletes an IPv4 resource pool.

Output

Sample XML Output