Cisco Cisco Prime IP Express 8.3 Technical References

Page of 1286
Resource: CCMCluster
This resource is used to manage the 
 class of Network Registrar objects.
Defines a server cluster. A CCMCluster object contains the configuration data associated with the cluster, including
remote connection information uch as IP address, port, admin, and password.
Functions
Get CCMCluster Object List
Gets the list of Network Registrar CCMCluster objects.
Request:
GET /web-services/rest/resource/CCMCluster 
CCMCluster 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.
Response:
Returns the list of CCMCluster 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.
Get CCMCluster Object By Name
Gets the Network Registrar CCMCluster object by name.
Request:
GET /web-services/rest/resource/CCMCluster/{objectName}
objectName
: the string representation of the CCMCluster name property or the key name
LocalServer to get the CCMCluster object that matches the specified search criteria. 
Search Parameters 
  fqdn: a DNS domain name or FQDN 
  viewId: the DNS view identifier, if applicable 
  address: an IP v4 or v6 address or subnet 
  vpnId: the VPN identifier for the address, if applicable 
  scope: a DHCP v4 scope name (if specified, address criteria are ignored) 
  prefix: a DHCP v6 prefix name (if specified, address criteria are ignored) 
  link: a DHCP v6 link name (if specified, address criteria are ignored)
Response:
Returns the CCMCluster object
Content-Type: application/xml, application/json
Put CCMCluster Object By Name
Modifies or creates the specified Network Registrar CCMCluster object.
Request:
PUT /web-services/rest/resource/CCMCluster/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the CCMCluster 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