Cisco Cisco Prime IP Express 8.3 Technical References

This resource is used to manage the 

 class of Network Registrar objects.

A DHCP Scope object. A scope defines a set of dynamic address pools on a subnet that share its configuration
attributes. A scope can also contain reserved addresses on the specified subnet that should use the configuration.

Gets the list of Network Registrar Scope objects.

Request:

GET /web-services/rest/resource/Scope 

Scope string properties may be specified as query parameters to filter the return list. Filter values
can specify a regular expression or exact match. Use an empty string to test for unset values. If
the vpnId parameter is not specified, the default VPN will be used for the request.

Response:

Returns the list of Scope objects
Content-Type: application/xml, application/json

If the list exceeds the maximum return list size, the next link is provided to get the next set of
objects.

Gets the Network Registrar Scope object by name.

Request:

GET /web-services/rest/resource/Scope/{objectName}
objectName: the string representation of the Scope name property

Response:

Returns the Scope object
Content-Type: application/xml, application/json

Modifies or creates the specified Network Registrar Scope object.

Request:

PUT /web-services/rest/resource/Scope/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the Scope name property

Response:

Returns the location of the Scope object, if created
Content: none

Creates a Network Registrar Scope object.

Request:

POST /web-services/rest/resource/Scope
Accept: application/xml, application/json, application/x-www-form-urlencoded 

These required Scope properties must be specified in the input object or form: 
  name: The name of the scope object. 
  subnet: The network address of the IP subnet that this scope represents.

Response:

Returns the location of the new Scope object
Content: none