Cisco Cisco Prime Collaboration Assurance 11.5 Guia Do Programador

Página de 32
 
 
© 2016 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public  
Page 13 
 
then the same can be provided using field privateIp. 
When a private IP is provided in the input then customer name is a 
mandatory field to associate the device to a customer. 
The private dns field can be used to provide the private hostname of the 
device. 
Customer name can be provided using the input field admGroupName. 
To disable logical discovery when adding a seed device like CUCM, 
TMS, VCS set the enableLogicalDiscovery flag to false
Note: Private IP, Customer name will be considered only if the PC 
deployment is in MSP mode. 
In case of edit devices, API allows only editing the credentials as rest of 
the device attributes are dynamically populated during discovery 
process. 
In order to change customer association of a device use 
/device/customer url, since there is no need to re-discover the devices. 
To know what credentials are mandatory for a particular device type refer  
 
For certain devices like VCenter which does not have an associated 
credentials, provide some junk value as SNMP Read CS because SNMP 
Read CS is a mandatory credential input for any device. 
responses 
status: 
200 - OK 
representations 
application/json    Example: 
The output of this API is a JSON that will contain the overall result of the 
operation, values can be 
SUCCESS - if the operation on all the devices was successful. 
FAILURE - if the operation on all the devices failed. 
PARTIALLY SUCCESFUL - if the operation succeeded on some of the 
devices. 
  
The response will also contain result per device which will contain the 
status as 
SUCCESS - if the device was added successfully and a discovery job is 
created. 
FAILURE - In the event of a failure to add a device the error code and 
message fields will also be populated. 
DELETE 
deleteDevice () 
API to delete a device. 
request 
query params