Cisco Cisco Prime IP Express 8.3 Technical References

This resource is used to manage the 

 class of Network Registrar objects.

This object represents a physical network link. Multiple logical IP networks may be running concurrently on the same
link.

Gets the list of Network Registrar Link objects.

Request:

GET /web-services/rest/resource/Link 

Link 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 Link 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 Link object by name.

Request:

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

Response:

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

Modifies or creates the specified Network Registrar Link object.

Request:

PUT /web-services/rest/resource/Link/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the Link name property 
Query Parameters 
  action: extra action to perform; value can be 'push' 

When connected to a regional server, the optional push action will push the object to the
specified local clusters after changes are made. If the input object is null, or identical to the
currently saved object, only the push action will be performed. 
Action Parameters 
  localCluster: the cluster or pair name; use repeated parameters or a comma-separated list to
specify a multiple entries 
  mode: the sync mode; value can be 'ensure', 'replace', or 'exact' 

At least one local cluster or pair must be specified. By default, changes will be made in 'replace'
mode.

Response:

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