The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter contains the following sections:
Managing Firmware
The examples in this category consist of various firmware management tasks on Cisco IMC Supervisor. These include firmware image management in network locations, downloading them from cisco.com and also triggering a firmware upgrade operation on servers.
Create a firmware image in a network location.
The HUU Image must be available in a network location - NFS/CIFS/HTTP.
/cloupia/api-v2/CreateNetworkImage
The parameters of the NETWORK_IMAGE_CREATE API are:
String profileName—The unique name of the profile.
String platform—The name of the platform.
String networkServerType—Network File System (NFS), Common Internet File System (CIFS) or HTTP/S server types.
String locationLink—A valid HTTP/HTTPS URL link for the image location.
String networkPath—The network path.
String sharePath—The network share path.
String remoteFileName—A remote filename.
String nwPathUserName—Optional. The network path user name.
String nwPathPassword—Optional. The network path password.
String mountOptions—Optional. The valid mount options.
<cuicOperationRequest> <operationType>NETWORK_IMAGE_CREATE</operationType> <payload> <![CDATA[ <CreateNetworkImage> <profileName></profileName> <platform></platform> <networkServerType>NFS</networkServerType> <!-- Set this value only when networkServerType equals to HTTP --> <locationLink></locationLink> <!-- Set this value only when networkServerType not equals to HTTP --> <networkPath></networkPath> <!-- Set this value only when networkServerType not equals to HTTP --> <sharePath></sharePath> <!-- Set this value only when networkServerType not equals to HTTP --> <remoteFileName></remoteFileName> <nwPathUserName></nwPathUserName> <nwPathPassword></nwPathPassword> <!-- Set this value only when networkServerType equals to CIFS --> <mountOptions></mountOptions> </CreateNetworkImage> ]]> </payload> </cuicOperationRequest>
Profile Name is mandatory and must be unique. Platform, Server Type (NFS/CIFS/HTTP) is mandatory. Remote IP, Remote Share, Remote Filename are mandatory in case of NFS/CIFS. The HTTP Location must be reachable from the system.
Update a firmware image in a network location.
The HUU Image must be available in a network location - NFS/CIFS/HTTP.
/cloupia/api-v2/UpdateNetworkImage
The parameters of the NETWORK_IMAGE_UPDATE API are:
String imageId—The unique ID of the image.
boolean platform—The platform that manages a server.
String networkServerType—Network File System (NFS), Common Internet File System (CIFS) or HTTP/S server types.
String locationLink—A valid HTTP/HTTPS URL link for the image location.
String networkPath—The network path.
String sharePath—The network share path.
String remoteFileName—A remote filename.
String nwPathUserName—Optional. The network path user name.
String nwPathPasswprd—Optional. The network path password.
String mountOptions—Optional. The valid mount options.
<cuicOperationRequest> <operationType>NETWORK_IMAGE_UPDATE</operationType> <payload> <![CDATA[ <UpdateNetworkImage> <imageId></imageId> <platform></platform> <networkServerType>NFS</networkServerType> <!-- Set this value only when networkServerType equals to HTTP --> <locationLink></locationLink> <!-- Set this value only when networkServerType not equals to HTTP --> <networkPath></networkPath> <!-- Set this value only when networkServerType not equals to HTTP --> <sharePath></sharePath> <!-- Set this value only when networkServerType not equals to HTTP --> <remoteFileName></remoteFileName> <nwPathUserName></nwPathUserName> <nwPathPassword></nwPathPassword> <!-- Set this value only when networkServerType equals to CIFS --> <mountOptions></mountOptions> </UpdateNetworkImage> ]]> </payload> </cuicOperationRequest>
Profile Name cannot be modified. Platform, Server Type (NFS/CIFS/HTTP) are mandatory. Remote IP, Remote Share, Remote Filename are mandatory in case of NFS/CIFS. The HTTP Location must be reachable from the system.
Find a firmware image on cisco.com.
The user must have a valid set of credentials to login to cisco.com and have access privileges for HUU ISO images.
/cloupia/api-v2/FindFirmwareImage
The parameters of the LOCAL_IMAGE_FIND API are:
String platform—The name of the platform.
String username—ISO share login user name.
String password—ISO share login password.
boolean enableProxy—Optional. Enable proxy configuration.
String host—The host name for the proxy configuration.
String port—Port for the proxy configuration.
boolean enableProxyAuth—Optional. Enable proxy authentication.
String proxyAuthUserName—Proxy username for the proxy authentication.
String proxyAuthPassword—Password for the proxy username.
<cuicOperationRequest> <operationType>LOCAL_IMAGE_FIND</operationType> <payload> <![CDATA[ <FindFirmwareImage> <platform></platform> <username></username> <password></password> <enableProxy>false</enableProxy> <!-- Set this value only when enableProxy equals to true --> <host></host> <!-- Set this value only when enableProxy equals to true --> <port>0</port> <!-- Set this value only when enableProxy equals to true --> <enableProxyAuth>false</enableProxyAuth> <!-- Set this value only when enableProxyAuth equals to true --> <proxyAuthUserName></proxyAuthUserName> <!-- Set this value only when enableProxyAuth equals to true --> <proxyAuthPassword></proxyAuthPassword> </FindFirmwareImage> ]]> </payload> </cuicOperationRequest>
Username/Password for cisco.com and platform are mandatory. The platform of a server that is already added into the system.
Create a firmware image in a local location inside the appliance.
The user must have a valid set of credentials to login to cisco.com and have access privileges for HUU ISO images. The HUU Image must be downloadable from cisco.com, and must be found using the FindFirmwareImage API.
/cloupia/api-v2/CreateLocalImage
The parameters of the LOCAL_IMAGE_CREATE API are:
String profileName—The unique name of the profile.
String platform—The name of the platform.
String username—ISO share login user name.
String password—ISO share login password.
String availableImage—The available .iso image.
boolean enableProxy—Optional. Enable proxy configuration.
String host—The host name for the proxy configuration.
String port—Port for the proxy configuration.
boolean enableProxyAuth—Optional. Enable proxy authentication.
String proxyAuthUserName—Proxy username for the proxy authentication.
String proxyAuthPassword—Password for the proxy username.
boolean acceptLicense—Accept license agreement.
boolean downloadNow—download the .iso image immediately after adding a profile.
<cuicOperationRequest> <operationType>LOCAL_IMAGE_CREATE</operationType> <payload> <![CDATA[ <CreateLocalImage> <profileName></profileName> <platform></platform> <username></username> <password></password> <availableImage></availableImage> <enableProxy>false</enableProxy> <!-- Set this value only when enableProxy equals to true --> <host></host> <!-- Set this value only when enableProxy equals to true --> <port>0</port> <!-- Set this value only when enableProxy equals to true --> <enableProxyAuth>false</enableProxyAuth> <!-- Set this value only when enableProxyAuth equals to true --> <proxyAuthUserName></proxyAuthUserName> <!-- Set this value only when enableProxyAuth equals to true --> <proxyAuthPassword></proxyAuthPassword> <acceptLicense>false</acceptLicense> <downloadNow>false</downloadNow> </CreateLocalImage> ]]> </payload> </cuicOperationRequest>
Profile Name is mandatory, must be unique. Username/Password for cisco.com and Platform are mandatory. The Platform must be that of a server already added into the system.
Download an image from cisco.com for an already configured firmware image profile, into a local location inside the appliance.
The firmware image profile must be already configured.
/cloupia/api-v2/DownloadLocalImage
The parameter of the LOCAL_IMAGE_DOWNLOAD API is:
<cuicOperationRequest> <operationType>LOCAL_IMAGE_DOWNLOAD</operationType> <payload> <![CDATA[ <DownloadLocalImage> <profileName></profileName> </DownloadLocalImage> ]]> </payload> </cuicOperationRequest>
Profile Name is mandatory, must be a valid existing profile for a Local Image. The image should not be already downloading.
Delete one or more existing firmware image profiles.
None
/cloupia/api-v2/CIMCFirmwareUpgradeConfig
The parameters of the FIRMWARE_IMAGE_DELETE API are:
<cuicOperationRequest> <operationType>FIRMWARE_IMAGE_DELETE</operationType> <payload> <![CDATA[ <DeleteFirmwareImage> <profileId></profileId> </DeleteFirmwareImage> ]]> </payload> </cuicOperationRequest>
Profile name is mandatory and must be unique. IP address search criteria is mandatory, but CSV File option is not supported through API.
Run a firmware upgrade on one or more servers using an already configured firmware image profile.
The firmware image profile must be already configured and must contain a valid HUU ISO Image.
/cloupia/api-v2/UpgradeFirmWareConfig
The parameters of the RUN_FIRMWARE_UPGRADE API are:
<cuicOperationRequest> <operationType>RUN_FIRMWARE_UPGRADE</operationType> <payload> <![CDATA[ <UpgradeFirmWareConfig> <profileName></profileName> <servers></servers> <enableSchedule>false</enableSchedule> <!-- Set this value only when enableSchedule not equals to false --> <associatedScheduleName></associatedScheduleName> </UpgradeFirmWareConfig> ]]> </payload> </cuicOperationRequest>
Profile name is mandatory, must be a valid existing profile. For a local profile, the image should not be already downloading. The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}. In case of schedule option, a valid schedule name must be provided.
Get Firmware Image By Profile Name
None
/cloupia/api-v2/CIMCFirmwareUpgradeConfig/{CIMCFirmwareUpgradeConfigId}
This task allows the user to query the firmware image details based on the profile name The CIMCFirmwareUpgradeConfigId argument must be a valid profile name. If no argument is specified, all firmware images configured in the system will be returned.
Get firmware image by type.
None
/cloupia/api-v2/CIMCFirmwareImageByType/{CIMCFirmwareImageByTypeId}
This task allows the user to query the firmware image details based on the type of location - NETWORK or LOCAL. The CIMCFirmwareImageByTypeId argument must be one of these values - NETWORK or LOCAL. If no argument is specified, all firmware images configured in the system will be returned.
Get firmware image by platform.
None
/cloupia/api-v2/CIMCFirmwareImageByPlatform/{CIMCFirmwareImageByPlatformId}
This task allows the user to query the firmware image details based on the platform. The CIMCFirmwareImageByPlatformId argument must be a valid platform name. If no argument is specified, all firmware images configured in the system will be returned.
Image download status by profile name.
None
/cloupia/api-v2/LocalImageDownloadStatusByProfileName/{LocalImageDownloadStatusByProfileNameId
This task allows the user to query the download status of a local firmware image based on the profile name The LocalImageDownloadStatusByProfileNameId argument must be a valid profile name. If no argument is specified, an empty set of results will be returned.
Firmware upgrade status by profile name.
None
/cloupia/api-v2/CIMCFirmwareUpgradeStatusbyProfileName/{CIMCFirmwareUpgradeStatusbyProfileNameId}
This task allows the user to query the firmware upgrade status of one or more servers based on the profile name of the image. The CIMCFirmwareUpgradeStatusbyProfileNameId argument must be a valid profile name. If no argument is specified, all firmware upgrade operations' status will be returned.
Firmware upgrade status by server IP address.
None
>/cloupia/api-v2/CIMCFirmwareUpgradeStatusbyServerIP/{CIMCFirmwareUpgradeStatusbyServerIPId}
This task allows the user to query the firmware upgrade status of one or more servers based on the profile name of the image. The CIMCFirmwareUpgradeStatusbyProfileNameId argument must be a valid profile name. If no argument is specified, all firmware upgrade operations' status will be returned. The dots in the IP address need to be substituted with an underscore.
Managing Platform Tasks
The examples in this category consists of managing email alert rules on Cisco IMC Supervisor.
Create an email alert rule for notification of faults.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfig
The parameters of the EMAIL_ALERT_RULE_CREATE API are:
String name—The name for the email alert.
String alertLevel—The alert level.
String serverGroups—Optional. The server groups to which email alerts are sent.
String emailAddress—The email address of the intended recipients of the email alert.
String severity—Fault severity levels for which email alerts will be sent.
Boolean enabled—Optional. Enable email alerts to the configured email address.
<cuicOperationRequest> <operationType>EMAIL_ALERT_RULE_CREATE</operationType> <payload> <![CDATA[ <CIMCEmailAlertRuleConfig> <name></name> <alertLevel>SYSTEM</alertLevel> <!-- Set this value only when alertLevel not equals to SYSTEM --> <serverGroups></serverGroups> <emailAddress></emailAddress> <severity>critical</severity> <enabled>false</enabled> </CIMCEmailAlertRuleConfig> ]]> </payload> </cuicOperationRequest>
Rule name is mandatory and must be unique. Email addresses are mandatory.
Get details of email alert rules.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfig/{CIMCEmailAlertRuleConfigId}
The Id argument must be a valid Rule name. If no argument is specified, all email alert rules configured in the system will be returned.
Update an existing email alert rule.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfig
The parameters of the EMAIL_ALERT_RULE_UPDATE API are:
String emailAlertRule—The email alert rule.
String alertLevel—The alert level.
String serverGroups—Optional. The server groups to which email alerts are sent.
String emailAddress—The email used to notify the group owner about the status of service requests and request approvals if necessary.
String severity—Fault severity levels for which email alerts will be sent.
Boolean enabled—Optional. Enable email alerts to the configured email address.
<cuicOperationRequest> <operationType>EMAIL_ALERT_RULE_UPDATE</operationType> <payload> <![CDATA[ <ModifyEmailAlertRuleConfig> <emailAlertRule></emailAlertRule> <alertLevel>SYSTEM</alertLevel> <!-- Set this value only when alertLevel not equals to SYSTEM --> <serverGroups></serverGroups> <emailAddress></emailAddress> <severity></severity> <enabled>false</enabled> </ModifyEmailAlertRuleConfig> ]]> </payload> </cuicOperationRequest>
Rule name cannot be modified.
Delete one or more existing Email Alert Rules.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfig
String emailAlertRule—The email alert rule.
<cuicOperationRequest> <operationType>EMAIL_ALERT_RULE_DELETE</operationType> <payload> <![CDATA[ <DeleteEmailAlertRuleConfig> <emailAlertRule></emailAlertRule> </DeleteEmailAlertRuleConfig> ]]> </payload> </cuicOperationRequest>
Comma separated list of rule names, all of which must be of valid existing rules.
Managing Server Tasks
The examples in this category consist of various server management tasks, such as discovery of servers through IP addresses, importing of discovered servers, power actions on servers and various methods to query server data, inventory data, and fault data.
Create a rack group to group servers logically in Cisco IMC Supervisor.
None
/cloupia/api-v2/CIMCRackGroup
The parameters of the RACK_GROUP_CREATE API are:
<cuicOperationRequest> <operationType>RACK_GROUP_CREATE</operationType> <payload> <![CDATA[ <CIMCRackGroup> <groupName></groupName> <description></description> </CIMCRackGroup> ]]> </payload> </cuicOperationRequest>
Group Name is mandatory and must be unique.
Get rack group details.
None
/cloupia/api-v2/CIMCRackGroup/{CIMCRackGroupId}
None
<cuicOperationResponse><cuicOperationStatus>0</cuicOperationStatus> <response><CIMCRackGroup><actionId>0</actionId><configEntryId>0</configEntryId> <defaultGroup>true</defaultGroup><description>Default provided rack group </description><groupName>Default Group</groupName></CIMCRackGroup><CIMCRackGroup> <actionId>0</actionId><configEntryId>0</configEntryId><defaultGroup>false </defaultGroup><description>Test55</description><groupName>Test66</groupName> </CIMCRackGroup><CIMCRackGroup><actionId>0</actionId><configEntryId>0 </configEntryId><defaultGroup>false</defaultGroup><description>apitest </description><groupName>apitest-ren</groupName></CIMCRackGroup><CIMCRackGroup> <actionId>0</actionId><configEntryId>0</configEntryId><defaultGroup>false </defaultGroup><description></description><groupName>Test3-SumanthRen</groupName> </CIMCRackGroup></response></cuicOperationResponse>
The Id argument must be a valid Rack Group name. If no argument is specified, all Rack Groups configured in the system will be returned.
Update an existing Rack Group.
None
/cloupia/api-v2/CIMCRackGroup
The parameters of the RACK_GROUP_UPDATE API are:
<cuicOperationRequest> <operationType>RACK_GROUP_UPDATE</operationType> <payload> <![CDATA[ <ModifyRackGroup> <groupID></groupID> <groupName></groupName> <description></description> </ModifyRackGroup> ]]> </payload> </cuicOperationRequest>
Group name is mandatory and must be unique.
Delete one or more existing rack groups.
None
/cloupia/api-v2/CIMCRackGroup
The parameters of the RACK_GROUP_DELETE API are:
<cuicOperationRequest> <operationType>RACK_GROUP_DELETE</operationType> <payload> <![CDATA[ <DeleteRackGroup> <groupID></groupID> <forceDelete>false</forceDelete> </DeleteRackGroup> ]]> </payload> </cuicOperationRequest>
Comma separated list of group names, all of which must be of valid existing rack groups.
Create a discovery profile to use for discovering servers based on IP address and importing them.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfig
String profileName—The name of the profile.
boolean isRange—Optional. The range
String option—The option.
String ipList—List of IP addresses.
String startRange—Valid beginning IP address.
String endRange—Valid last IP address.
String networkAddress—The network IP address.
String subnetMask—The range of subnet mask.
String csvFile—Search by csv file.
boolean credentialPolicy—Optional. Create a credential policy.
String policy—Optional. The policy name.
String username—The server login name.
String password—The server login password.
String protocol—Optional. HTTP or HTTPS protocol.
int port—The port number.
<cuicOperationRequest> <operationType>DISCOVERY_PROFILE_CREATE</operationType> <payload> <![CDATA[ <CIMCDeviceDiscoveryConfig> <profileName></profileName> <option>IP</option> <!-- Set this value only when option equals to IPLIST --> <ipList></ipList> <!-- Set this value only when option equals to IP --> <startRange></startRange> <!-- Set this value only when option equals to IP --> <endRange></endRange> <!-- Set this value only when option equals to SUBNET --> <networkAddress></networkAddress> <!-- Set this value only when option equals to SUBNET --> <subnetMask></subnetMask> <!-- Set this value only when option equals to CSV --> <csvFile></csvFile> <credentialPolicy>false</credentialPolicy> <!-- Set this value only when credentialPolicy not equals to false --> <policy></policy> <!-- Set this value only when credentialPolicy not equals to true --> <username></username> <!-- Set this value only when credentialPolicy not equals to true --> <password></password> <!-- Set this value only when credentialPolicy not equals to true --> <protocol>https</protocol> <!-- Set this value only when credentialPolicy not equals to true --> <port>443</port> </CIMCDeviceDiscoveryConfig> ]]> </payload> </cuicOperationRequest>
Profile Name is mandatory, must be unique. IP Address Search Criteria is mandatory, but CSV File option is not supported via API.
Get discovery profiles details.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfig/{CIMCDeviceDiscoveryConfigId}
The Id argument must be a valid profile name. If no argument is specified, all discovery profiles configured in the system will be returned.
Update an existing discovery profile.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfig
String profileName—The unique name of the profile.
String option—The option.
String ipList—List of IP addresses.
String startRange—Valid beginning IP address.
String endRange—Valid last IP address.
String networkAddress—The network IP address.
String subnetMask—The range of subnet mask.
String csvFile—Search by csv file.
boolean credentialPolicy—Optional. Create a credential policy.
boolean policy—Optional. The policy name.
String username—The server login name.
String password—The server login password.
String protocol—Optional. HTTP or HTTPS protocol.
int port—The port number.
<cuicOperationRequest> <operationType>DISCOVERY_PROFILE_UPDATE</operationType> <payload> <![CDATA[ <ModifyCIMCDeviceDiscoveryProfile> <profileName></profileName> <option>IP</option> <!-- Set this value only when option equals to IPLIST --> <ipList></ipList> <!-- Set this value only when option equals to IP --> <startRange></startRange> <!-- Set this value only when option equals to IP --> <endRange></endRange> <!-- Set this value only when option equals to SUBNET --> <networkAddress></networkAddress> <!-- Set this value only when option equals to SUBNET --> <subnetMask></subnetMask> <!-- Set this value only when option equals to CSV --> <csvFile></csvFile> <credentialPolicy>false</credentialPolicy> <!-- Set this value only when credentialPolicy not equals to false --> <policy></policy> <!-- Set this value only when credentialPolicy not equals to true --> <username></username> <!-- Set this value only when credentialPolicy not equals to true --> <password></password> <!-- Set this value only when credentialPolicy not equals to true --> <protocol>https</protocol> <!-- Set this value only when credentialPolicy not equals to true --> <port>443</port> </ModifyCIMCDeviceDiscoveryProfile> ]]> </payload> </cuicOperationRequest>
Profile Name cannot be modified.
Delete one or more existing discovery profiles.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfig
<cuicOperationRequest> <operationType>DISCOVERY_PROFILE_DELETE</operationType> <payload> <![CDATA[ <DeleteCIMCDeviceDiscoveryProfile> <profileName></profileName> </DeleteCIMCDeviceDiscoveryProfile> ]]> </payload> </cuicOperationRequest>
Comma separated list of profile names, all of which must be of valid existing profiles.
Run a Discovery operation to discovery servers based on IP addresses, using one or more configured Discovery Profiles.
Discovery Profile must be configured.
/cloupia/api-v2/CIMCAutoDiscoveryConfig
<cuicOperationRequest> <operationType>RUN_SERVER_DISCOVERY</operationType> <payload> <![CDATA[ <CIMCAutoDiscoveryConfig> <profileNames></profileNames> <enableSchedule>false</enableSchedule> <!-- Set this value only when enableSchedule not equals to false --> <associatedScheduleName></associatedScheduleName> </CIMCAutoDiscoveryConfig> ]]> </payload> </cuicOperationRequest>
Comma-separated list of valid profile names. In case of schedule option, a valid schedule name must be provided.
Get discovered device details.
One or more servers must have been discovered using a discovery profile
/cloupia/api-v2/CIMCDiscoveredDevice/{CIMCDiscoveredDeviceId}/State/{StateId}
Import one or more discovered devices.
One or more servers must have been discovered using a Discovery Profile.
/cloupia/api-v2/ImportRackServersConfig
<cuicOperationRequest> <operationType>IMPORT_SERVER</operationType> <payload> <![CDATA[ <ImportRackServersConfig> <devices></devices> <userPrefix></userPrefix> <description></description> <contact></contact> <location></location> <rackGroup>Default Group</rackGroup> </ImportRackServersConfig> ]]> </payload> </cuicOperationRequest>
Comma-separated list of one or more valid server IP addresses, which have been discovered. Group name of an existing rack group.
Hard reset one or more servers.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/HardResetAction
<cuicOperationRequest> <operationType>HARD_RESET_SERVER</operationType> <payload> <![CDATA[ <HardResetServer> <serverIdKey></serverIdKey> </HardResetServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress }
Power cycle one or more servers.
One or more servers must be configured as rack accounts.
/cloupia/api-v2/PowerCycleAction
<cuicOperationRequest> <operationType>POWER_CYCLE_SERVER</operationType> <payload> <![CDATA[ <PowerCycleServer> <serverIdKey></serverIdKey> </PowerCycleServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress }
Power Off one or more Servers.
One or more Servers must be configured as Rack Accounts
/cloupia/api-v2/PowerOffAction
<cuicOperationRequest> <operationType>POWER_OFF_SERVER</operationType> <payload> <![CDATA[ <PowerOffServer> <serverIdKey></serverIdKey> </PowerOffServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress
Power On server.
Power On one or more servers.
One or more servers must be configured as rack accounts.
/cloupia/api-v2/PowerOnAction
<cuicOperationRequest> <operationType>POWER_ON_SERVER</operationType> <payload> <![CDATA[ <PowerOnServer> <serverIdKey></serverIdKey> </PowerOnServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.
Shut down one or more servers.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/ShutDownAction
<cuicOperationRequest> <operationType>SHUT_DOWN_SERVER</operationType> <payload> <![CDATA[ <ShutDownServer> <serverIdKey></serverIdKey> </ShutDownServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.
Set label for one or more servers.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/SetLabelAction
<cuicOperationRequest> <operationType>SET_LABEL</operationType> <payload> <![CDATA[ <SetLabelServer> <serverIdKey></serverIdKey> <setLabel></setLabel> </SetLabelServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.
Toggle Locator LED one or more Servers.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/LocatorLedAction
<cuicOperationRequest> <operationType>LOCATOR_LED</operationType> <payload> <![CDATA[ <LocatorLedServer> <serverIdKey></serverIdKey> <locatorLed>ON</locatorLed> </LocatorLedServer> ]]> </payload> </cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.
Get servers which are tagged with a specific name.
One or more servers must be configured as Rack Accounts and be tagged.
/cloupia/api-v2/ServersByTagName/{ServersByTagNameId}
The ServersByTagValueId argument must be a valid tag value defined in the Tag Library.
Get Servers which are tagged with a specific value.
One or more servers must be configured as Rack Accounts and be tagged.
/cloupia/api-v2/ServersByTagValue/{ServersByTagValueId}
The ServersByTagValueId argument must be a valid tag value defined in the Tag Library.
Get Server Faults by affected DN.
None
/cloupia/api-v2/CIMCFaultsByDN/{CIMCFaultsByDNId}
The CIMCFaultsByDNId argument must be a valid DN value. The RNs in the DN must be separated by an underscore instead of a forward slash.
Get Faults of a specific server by its IP address.
None
/cloupia/api-v2/CIMCFaultsByServerIP/{CIMCFaultsByServerIPId}
The CIMCFaultsByServerIPId argument must be a valid IP Address. The dots in the IP address need to be substituted with an underscore.
Get Faults of a specific server by its Account Name.
None
/cloupia/api-v2/CIMCFaultsByAccountName/{CIMCFaultsByAccountNameId}
The CIMCFaultsByAccountNameId argument must be a valid Account Name of a server being managed by IMCS.
Get Server Faults by Severity level.
None
/cloupia/api-v2/CIMCFaultsBySeverity/{CIMCFaultsBySeverityId}
The CIMCFaultsBySeverityId argument must be a valid Severity Level.
Get Server Faults by Fault Code.
None
/cloupia/api-v2/CIMCFaultsByCode/{CIMCFaultsByCodeId}
The CIMCFaultsByCodeId argument must be a valid Fault Code.
Get Server Faults by affected DN.
None
/cloupia/api-v2/CIMCFaultsHistoryByDN/{CIMCFaultsHistoryByDNId}
The CIMCFaultsHistoryByDNId argument must be a valid DN value. The RNs in the DN must be separated by an underscore instead of a forward slash.
Get Faults History of a specific server by its IP address.
None
/cloupia/api-v2/CIMCFaultsHistoryByServerIP/{CIMCFaultsHistoryByServerIPId}
The CIMCFaultsHistoryByServerIPId argument must be a valid IP address of a server being managed by IMCS. The dots in the IP address need to be substituted with an underscore.
Get Faults History of a specific server by its Account Name.
None
/cloupia/api-v2/CIMCFaultsHistoryByAccountName/{CIMCFaultsHistoryByAccountNameId}
The CIMCFaultsHistoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.
Get Server Faults History by Severity level.
None
/cloupia/api-v2/CIMCFaultsHistoryBySeverity/{CIMCFaultsHistoryBySeverityId}
The CIMCFaultsHistoryBySeverityId argument must be a valid Severity Level.
Get Server Faults History by Fault Code.
None
/cloupia/api-v2/CIMCFaultsHistoryByCode/{CIMCFaultsHistoryByCodeId}
The CIMCFaultsHistoryByCodeId argument must be a valid Fault Code.
Get Server By Product ID.
None
/cloupia/api-v2/CIMCServerByProductID/{CIMCServerByProductIDId}
The CIMCServerByProductIDId argument must be a valid Product ID of a server being managed by Cisco IMC Supervisor.
Get Servers By Account Name
None
/cloupia/api-v2/CIMCServerByAccountName/{CIMCServerByAccountNameId}
The CIMCServerByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.
Get Server By UUID
None
/cloupia/api-v2/CIMCServerByUUID/{CIMCServerByUUIDId}
The CIMCServerByUUIDId argument must be a valid UUID of a server being managed by Cisco IMC Supervisor.
Get Server By IP Address.
None
/cloupia/api-v2/CIMCServerByServerIP/{CIMCServerByServerIPId}
The CIMCServerByServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor. The dots in the IP address need to be substituted with an underscore.
Get Server By Serial Number.
None
/cloupia/api-v2/CIMCServerBySerialNum/{CIMCServerBySerialNumId}
The CIMCServerBySerialNumId argument must be a valid serial number of a server being managed by Cisco IMC Supervisor.
Get Server By Rack Group.
None
/cloupia/api-v2/CIMCServerByRackGroup/{CIMCServerByRackGroupId}
The CIMCServerByRackGroupId argument must be a valid Rack Group existing in Cisco IMC Supervisor.
Get Server Inventory By Account Name.
None
/cloupia/api-v2/CIMCServerInventoryByAccountName/{CIMCServerInventoryByAccountNameId}
The CIMCServerInventoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.
Get server inventory by IP address.
None
/cloupia/api-v2/CIMCServerInventoryByServerIP/{CIMCServerInventoryByServerIPId}
The CIMCServerInventoryByServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor. The dots in the IP address need to be substituted with an underscore.
Get Server Utilization By Account Name
None
/cloupia/api-v2/CIMCServerUtilizationByAccountName/{CIMCServerUtilizationByAccountNameId}
The CIMCServerUtilizationByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.
Get Server Utilization By IP Address.
None
/cloupia/api-v2/CIMCServerUtilizationByServerIP/{CIMCServerUtilizationByServerIPId}
The CIMCServerUtilizationByServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor. The dots in the IP address need to be substituted with an underscore.
Get Server Utilization History By Account Name.
None
/cloupia/api-v2/CIMCServerUtilizationHistoryByAccountName/{CIMCServerUtilizationHistoryByAccountNameId}
The CIMCServerUtilizationHistoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.
Get Server Utilization History By IP Address.
None
/cloupia/api-v2/CIMCServerUtilizationHistoryByServerIP/{CIMCServerUtilizationHistoryByServerIPId}
The CIMCServerUtilizationHistoryByServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor. The dots in the IP address need to be substituted with an underscore.
Managing Users and Groups
The examples in this category consists of managing users and user groups to access Cisco IMC Supervisor.
Create a group of users in Cisco IMC Supervisor. This task allows a user to create a new group, which denotes a related set of users.
None
/cloupia/api-v2/group
The parameters of the CREATE API are:
String groupName—The name of the group or the customer organization.
String groupDescription—Optional. The description of the group or the customer organization, if required.
String parentGroup—Optional. The name of the parent group.
String groupCode—Optional. A shorter name or code name for the group.
String groupContact—The contact name for the group.
String firstName—Optional. The first name of the group owner.
String lastName—Optional. The last name of the group owner.
String phone—Optional. The phone number of the group owner.
String address—Optional. The address of the group owner.
String groupSharePolicyId—Optional. The ID of group share policy for the users in this group.
Boolean allowPrivateUsers—Optional. The option that allows creating users with exclusive access to their resources.
<AddGroupConfig> <groupName></groupName> <groupDescription></groupDescription> <parentGroup></parentGroup> <groupCode></groupCode> <groupContact></groupContact> <firstName></firstName> <lastName></lastName> <phone></phone> <address></address> <groupSharePolicyId>0</groupSharePolicyId> <allowPrivateUsers>false</allowPrivateUsers> </AddGroupConfig>
The user group name is mandatory and must be unique. Contact Email is mandatory.
This task allows a user to update an existing group, which denotes a related set of users.
None
/cloupia/api-v2/group
The parameters of the UPDATE API are:
String groupId—The id of the group or the customer organization.
String groupDescription—Optional. The description of the group or the customer organization, if required.
String parentGroup—Optional. The name of the parent group.
String groupCode—Optional. A shorter name or code name for the group.
String costCenter—Optional. The cost centr for the group.
String groupContact—The contact name for the group.
String firstName—Optional. The first name of the group owner.
String lastName—Optional. The last name of the group owner.
String phone—Optional. The phone number of the group owner.
String address—Optional. The address of the group owner.
String groupSharePolicyId—Optional. The ID of group share policy for the users in this group.
Boolean allowPrivateUsers—Optional. The option that allows creating users with exclusive access to their resources.
<cuicOperationRequest> <payload> <![CDATA[ <ModifyGroupConfig> <groupId></groupId> <groupDescription></groupDescription> <parentGroup></parentGroup> <groupCode></groupCode> <costCenter></costCenter> <groupContact></groupContact> <firstName></firstName> <lastName></lastName> <phone></phone> <address></address> <groupSharePolicyId>0</groupSharePolicyId> <allowPrivateUsers>false</allowPrivateUsers> </ModifyGroupConfig> ]]> </payload> </cuicOperationRequest>
Name cannot be modified. The groupId tag is mandatory and must include the numeric ID of a valid existing group. Contact Email is mandatory.
This task allows a user to delete an existing group, which denotes a related set of users.
None
/cloupia/api-v2/group
The parameters of the DELETE_USER API are:
String groupName—The name of the group or the customer organization.
<cuicOperationRequest> <operationType>DELETE_GROUP</operationType> <payload> <![CDATA[ <DeleteGroupConfig> <groupID></groupID> </DeleteGroupConfig> ]]> </payload> </cuicOperationRequest>
The groupId tag is mandatory and must include the numeric ID of a valid existing group.
This task allows a user to enable all users which are assigned to a group.
None
/cloupia/api-v2/group
The parameter of the ENABLE_ALL_USERS_IN_GROUP API is:
String groupName—The name of the group or the customer organization.
<cuicOperationRequest> <operationType>ENABLE_ALL_USERS_IN_GROUP</operationType> <payload> <![CDATA[ <EnableAllUsersInGroupConfig> <groupID></groupID> </EnableAllUsersInGroupConfig> ]]> </payload> </cuicOperationRequest>
The groupId tag is mandatory and must include the numeric ID of a valid existing group.
This task allows a user to disable all users which are assigned to a Group.
None
/cloupia/api-v2/group
The parameter of the DISABLE_ALL_USERS_IN_GROUP API is:
String groupName—The name of the group or the customer organization.
<cuicOperationRequest> <operationType>DISABLE_ALL_USERS_IN_GROUP</operationType> <payload> <![CDATA[ <DisableAllUsersInGroupConfig> <groupID></groupID> </DisableAllUsersInGroupConfig> ]]> </payload> </cuicOperationRequest>
The groupId tag is mandatory and must include the numeric ID of a valid existing group.
This task allows the user to create a new user.
None
/cloupia/api-v2/user
The parameters of the CREATE API are:
String userType—The type of user.
String userGroup—Optional. The group of the user.
String mspOrganization—Optional. MSP organization user.
String loginName—The login name for the user.
String password—The password for the user.
String confirmPassword—Repeat the password from the previous field.
String userContactEmail—The email address.
String firstName—Optional. The first name of the group owner.
String lastName—Optional. The last name of the group owner.
String phone—Optional. The phone number of the group owner.
String address—Optional. The address of the group owner.
<cuicOperationRequest> <payload> <![CDATA[ <AddUserConfig> <userType>GroupAdmin</userType> <!-- Accepts value from the list: userGroupByType--> <userGroup>1</userGroup> <mspOrganization></mspOrganization> <loginName></loginName> <!-- Accepts value from the list: password--> <password></password> <!-- Accepts value from the list: password--> <confirmPassword></confirmPassword> <userContactEmail></userContactEmail> <firstName></firstName> <lastName></lastName> <phone></phone> <address></address> </AddUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must be unique. Password and Confirm Password are mandatory and the values must match. User Contact Email is mandatory. User Type is mandatory and must be an existing valid User Role. User Group Id is required only if the User Type is set to 'Group Admin', and it must denote the numeric Id of an existing User Group.
This task allows the user to query the details of an existing user. The userId argument must be a valid login name of a user. If no argument is specified, no results will be returned.
None
/cloupia/api-v2/user/{userId}
The userId argument must be a valid login name of a user. If no argument is specified, no results will be returned.
This task allows to update an existing user.
None
/cloupia/api-v2/user
The parameters of the UPDATE USER API are:
String loginName—The login name for the user.
String userType—The type of user.
String userGroup—Optional. The group of the user.
String mspOrganization—Optional. MSP organization user.
String userContactEmail—The email address.
String firstName—Optional. The first name of the group owner.
String lastName—Optional. The last name of the group owner.
String phone—Optional. The phone number of the group owner.
String address—Optional. The address of the group owner.
<cuicOperationRequest> <operationType>UPDATE_USER</operationType> <payload> <![CDATA[ <ModifyUserConfig> <loginName></loginName> <userType>GroupAdmin</userType> <userGroup>1</userGroup> <mspOrganization></mspOrganization> <userContactEmail></userContactEmail> <firstName></firstName> <lastName></lastName> <phone></phone> <address></address> </ModifyUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid user. It cannot be changed. User Contact Email is mandatory. User Type is mandatory and must be an existing valid User Role. User Group Id is required only if the User Type is set to 'Group Admin', and it must denote the numeric Id of an existing User Group.
This task allows to delete an existing User.
None
/cloupia/api-v2/user
The parameters of the DELETE_USER API are:
String loginName—The login name for the user.
<cuicOperationRequest> <operationType>DELETE_USER</operationType> <payload> <![CDATA[ <DeleteUserConfig> <loginName></loginName> </DeleteUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid user.
This task allows to enable an existing user whose account has been disabled.
None
/cloupia/api-v2/user
The parameter of the ENABLE_USER API is:
String loginName—The login name for the user.
<cuicOperationRequest> <operationType>ENABLE_USER</operationType> <payload> <![CDATA[ <EnableUserConfig> <loginName></loginName> </EnableUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid user.
This task allows to disable an existing User whose account has been enabled.
None
/cloupia/api-v2/user
The parameter of the DISABLE_USER API is:
String loginName—The login name for the user.
<cuicOperationRequest> <operationType>DISABLE_USER</operationType> <payload> <![CDATA[ <DisableUserConfig> <loginName></loginName> </DisableUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid user.
This task allows to update the expiry date of an existing user.
None
/cloupia/api-v2/user
The parameters of the DISABLE_DATE API are:
<cuicOperationRequest> <operationType>DISABLE_DATE</operationType> <payload> <![CDATA[ <ConfigureUserExpiryDateConfig> <loginName></loginName> <!-- Accepts value from the list: date_time--> <userExpiryDate>1460449200000</userExpiryDate> </ConfigureUserExpiryDateConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid User. Expiry Date is mandatory and must be represented in a numeric form denoting the timestamp of the expiry date/time.
This task allows to update an existing user password.
None
/cloupia/api-v2/user
The parameters of the UPDATE_USER_PASSWORD API are:
<cuicOperationRequest> <operationType>UPDATE_USER_PASSWORD</operationType> <payload> <![CDATA[ <AddUserConfig> <loginName></loginName> <!-- Accepts value from the list: password--> <password></password> <!-- Accepts value from the list: password--> <confirmPassword></confirmPassword> </AddUserConfig> ]]> </payload> </cuicOperationRequest>
Login Name is mandatory and must denote an existing valid User. Password and Confirm Password are mandatory and values must match.