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/NetworkImageThe 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.
Boolean Configure Graceful—Optional. Choose to configure graceful timeout.
String GracefulTimeout—The timeout in minutes.
Boolean DoForceDown—Enable to forcefully shutdown the server after graceful timeout is expired.
<cuicOperationRequest>
<operationType>NETWORK_IMAGE_CREATE</operationType>
<payload>
<![CDATA[
<NetworkImage>
<profileName>sample</profileName>
<platform>C220 M4</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>1.1.1.1</networkPath>
<!-- Set this value only when networkServerType not equals to HTTP -->
<sharePath>/var/www/test</sharePath>
<!-- Set this value only when networkServerType not equals to HTTP -->
<remoteFileName>sample_fileName</remoteFileName>
<nwPathUserName></nwPathUserName>
<nwPathPassword></nwPathPassword>
<!-- Set this value only when networkServerType equals to CIFS -->
<mountOptions></mountOptions>
<configureGraceful>true</configureGraceful>
<!-- Set this value only when configureGraceful not equals to false -->
<gracefulTimeOut>12</gracefulTimeOut>
<doForceDown>true</doForceDown>
</NetworkImage>
]]>
</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. Graceful Timeout is optional, to configure graceful timeout. Timeout (in mins), a graceful timeout period. Valid range is [0-60]. Force Shutdown Server, enable to forcefully down the server after Graceful timeout is expired.
Update a firmware image in a network location.
The HUU Image must be available in a network location - NFS/CIFS/HTTP.
/cloupia/api-v2/NetworkImageThe parameters of the NETWORK_IMAGE_UPDATE API are:
String profileName—Unique name of the profile.
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.
Boolean Configure Graceful—Optional. Choose to configure graceful timeout.
String GracefulTimeout—The timeout in minutes.
Boolean DoForceDown—Enable to forcefully shutdown the server after graceful timeout is expired.
<cuicOperationRequest>
<operationType>NETWORK_IMAGE_UPDATE</operationType>
<payload>
<![CDATA[
<NetworkImage>
<profileName>sample</profileName>
<platform>C220 M4</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>1.1.1.1</networkPath>
<!-- Set this value only when networkServerType not equals to HTTP -->
<sharePath>/var/www/</sharePath>
<!-- Set this value only when networkServerType not equals to HTTP -->
<remoteFileName>sample_file</remoteFileName>
<nwPathUserName></nwPathUserName>
<nwPathPassword></nwPathPassword>
<!-- Set this value only when networkServerType equals to CIFS -->
<mountOptions></mountOptions>
<configureGraceful>true</configureGraceful>
<!-- Set this value only when configureGraceful not equals to false -->
<gracefulTimeOut>10</gracefulTimeOut>
<doForceDown>true</doForceDown>
</NetworkImage>
]]>
</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. Graceful Timeout is optional, to configure graceful timeout. Timeout (in mins), a graceful timeout period. Valid range is [0-60]. Force Shutdown Server, enable to forcefully down the server after Graceful timeout is expired.
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/LocalImageThe 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[
<LocalImage>
<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>
</LocalImage>
]]>
</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 LocalImage API.
/cloupia/api-v2/LocalImageThe parameters of the LOCAL_IMAGE_CREATE API are:
String profileName—The unique name of the profile.
String platform—The name of the platform.
String availableImage—The available .iso image.
boolean acceptLicense—Accept license agreement.
boolean downloadNow—download the .iso image immediately after adding a profile.
Boolean Configure Graceful—Optional. Choose to configure graceful timeout.
String GracefulTimeout—The timeout in minutes.
Boolean DoForceDown—Enable to forcefully shutdown the server after graceful timeout is expired.
<cuicOperationRequest>
<operationType>LOCAL_IMAGE_CREATE</operationType>
<payload>
<![CDATA[
<LocalImage>
<profileName>sample</profileName>
<platform>C220 M4</platform>
<availableImage>sampleImage.iso</availableImage>
<downloadNow>false</downloadNow>
<configureGraceful>true</configureGraceful>
<!-- Set this value only when configureGraceful not equals to false -->
<gracefulTimeOut>10</gracefulTimeOut>
<doForceDown>true</doForceDown>
</LocalImage>
]]>
</payload>
</cuicOperationRequest>
Profile Name is mandatory, must be unique. Platform is mandatory. The Platform must be that of a server already added into the system. Graceful Timeout is optional, to configure graceful timeout. Timeout (in mins), a graceful timeout period. Valid range is [0-60]. Force Shutdown Server, enable to forcefully down the server after Graceful timeout is expired.
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/LocalImageThe parameter of the LOCAL_IMAGE_DOWNLOAD API is:
String profileName—The unique name of the profile.
<cuicOperationRequest>
<operationType>LOCAL_IMAGE_DOWNLOAD</operationType>
<payload>
<![CDATA[
<LocalImage>
<profileName></profileName>
</LocalImage>
]]>
</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/CIMCFirmwareUpgradeConfigThe parameters of the FIRMWARE_IMAGE_DELETE API are:
String profileNames—The unique name of the profile.
<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/RunFirmwareUpgradeThe parameters of the RUN_FIRMWARE_UPGRADE API are:
String profileName—The unique name of the profile.
String platform—The server platform name.
String imageVersion—The version of the image.
String imagePath—The path of the image.
String servers—Servers whose platform matches the one configured in the selected profile.
boolean enableSchedule—Enable a schedule
String associatedScheduleName—Name of the associate schedule.
<cuicOperationRequest>
<operationType>RUN_FIRMWARE_UPGRADE</operationType>
<payload>
<![CDATA[
<RunFirmwareUpgrade>
<profileName></profileName>
<servers></servers>
<enableSchedule>false</enableSchedule>
<!-- Set this value only when enableSchedule not equals to false -->
<associatedScheduleName></associatedScheduleName>
</RunFirmwareUpgrade>
]]>
</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/{LocalImageDownloadStatusByProfileNameIdThis 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.
Create a Host Image in a Network Location.
The Host Image must be present in the network location.
/cloupia/api-v2/HostImageNetworkImageThe parameters of the HostImageNetworkImage API are:
String Profile Name—The unique name of the profile.
String Platform—The platform that manages the server.
String Option Download Image From—The location from where the image must be downloaded from.
String Server—The IP address of the server.
String File Path Name—The file path
String File Type—The file type.
String File Name—The name of the file.
String User Name—The user name.
String Password—The password
Boolean Map After Download—Map the .iso image after download
Boolean Delete All Images—Deletes all images on the server.
Boolean Run Upgrade After Download—Run upgrade immediately after downloading the image.
<cuicOperationRequest>
<operationType>CREATE_HOST_IMAGE_PROFILE</operationType>
<payload>
<![CDATA[
<HostImageNetworkImage>
<profileName>sample</profileName>
<platform>EN120S M2</platform>
<option>FTP Server</option>
<server>100.10.10.10</server>
<pathFileName>/var/www/test</pathFileName>
<fileType>ISO</fileType>
<fileName>sample</fileName>
<!-- Set this value only when option not equals to any of {HTTP Server,HTTPS Server,} -->
<username>admin</username>
<!-- Set this value only when option not equals to any of {HTTP Server,HTTPS Server,} ->
<password>YWRtaW4=</password>
<!-- Set this value only when fileType not equals to any of {CIMC,BIOS,} -->
<mapAfterDownload>true</mapAfterDownload>
<deleteAllImages>true</deleteAllImages>
<upgradeNow>true</upgradeNow>
</HostImageNetworkImage>
]]>
</payload>
</cuicOperationRequest>Profile is a mandatory field and it must be unique. Platform, Download Image From, Server IP Address, File Path and File Name are also mandatory fields.
Apply a host image profile on an E-Series server.
One or more E -series servers must be configured as Rack Accounts.
/cloupia/api-v2/ApplyHostImageMapThe parameters of the ApplyHostImageMap API are:
String Server—The server on which the host image map must be applied
String Profile Name—The unique name of the profile.
Schedule Later—The option to apply the host image profile at a later point in time.
Schedule Name—The name of the schedule.
<cuicOperationRequest>
<operationType>APPLY_HOST_IMAGE_PROFILE</operationType>
<payload>
<![CDATA[
<ApplyHostImageMap>
<serverIdKey>100.100.xx.xxx;100.2x.4x.xxx</serverIdKey>
<profileName>sample</profileName>
</ApplyHostImageMap>
]]>
</payload>
</cuicOperationRequest>ServerIdKey is comma(,) separated value. ServerIdKey is of the format: {AccountName};{ServerIPAddress} and it is a mandatory field. Profile Name is mandatory field.
This task allows the user to create a CCO Image Profile that stores the downloaded file (from cisco.com) 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 BIN, SPA and ISO Images.
/cloupia/api-v2/CIMCHIMCCOImageThe parameters of the CIMCHIMCCOImage API are:
String Profile Name—The unique name of the profile.
String Platform—The platform that manages the server.
Boolean Download Now—Download the image immediately after adding a profile.
String Available Image—The available image.
Boolean Map After Download—Map the .iso image after download
Boolean Delete All Images—Deletes all images on the server.
Boolean Run Upgrade After Download—Run upgrade immediately after downloading the image.
String License Text—License text.
<cuicOperationRequest>
<operationType>CCO_IMAGE_CREATE</operationType>
<payload>
<![CDATA[
<CIMCHIMCCOImage>
<profileName>sample</profileName>
<platform>EN120S M2</platform>
<downloadNow>true</downloadNow>
<availableImage>sample.iso</availableImage>
<!-- Set this value only when fileType not equals to any of {CIMC,BIOS,} -->
<mapAfterDownload>true</mapAfterDownload>
<deleteAllImages>true</deleteAllImages>
<upgradeNow>true</upgradeNow>
<licenseText></licenseText>
</CIMCHIMCCOImage>
]]>
</payload>
</cuicOperationRequest>
Profile Name is mandatory, must be unique. Platform are mandatory. The platform must be that of a server already added into the system.
Delete one or more existing Host Image Mapping Profiles.
None
/cloupia/api-v2/DeleteHostImageProfileThe parameter of the DeleteHostImageProfile API is:
String Profile Name—One or more firmware image profiles to delete.
<cuicOperationRequest>
<operationType>DELETE_HOST_IMAGE_PROFILE</operationType>
<payload>
<![CDATA[
<DeleteHostImageProfile>
<profileNames>sample_profile_name</profileNames>
</DeleteHostImageProfile>
]]>
</payload>
</cuicOperationRequest>
Comma separated list of profile names, all of which must be of valid existing profiles.
This task allows the user to download a CCO Image from cisco.com into a local location inside the appliance.
The CCO Image Profile must be already configured.
/cloupia/api-v2/CIMCHIMCCOImageThe parameter of the CIMCHIMCCOImage API is:
String Profile Name—The unique name of the profile.
<cuicOperationRequest>
<operationType>CCO_IMAGE_DOWNLOAD</operationType>
<payload>
<![CDATA[
<CIMCHIMDownloadCCOImage>
<profileName>sampleCCOProfile</profileName>
</CIMCHIMDownloadCCOImage>
]]>
</payload>
</cuicOperationRequest>
Profile Name is mandatory, must be a valid existing profile for a Local Image. The image should not be already downloading.
This task allows the user to find a CCO Image (BIN,SPA or ISO Image) on cisco.com for only E-Series server platforms.
The user must have a valid set of credentials to login to cisco.com and have access privileges for BIN, SPA and ISO Images.
/cloupia/api-v2/CIMCHIMCCOImageThe parameter of the CIMCHIMCCOImage API is:
String Platform—The platform that manages the server.
<cuicOperationRequest>
<operationType>CCO_IMAGE_FIND</operationType>
<payload>
<![CDATA[
<CIMCHIMCCOImage>
<platform>EN120S M2</platform>
</CIMCHIMCCOImage>
]]>
</payload>
</cuicOperationRequest>
Platform is mandatory field. The Platform must be that of a server already added into the system.
This task allows the user to query the Host Image Mapping details based on the profile name
None
/cloupia/api-v2/CIMCHostImageProfileConfig/{CIMCHostImageProfileConfigId}The parameters of the CIMCHostImageProfileConfig API are:
String Profile Name—The unique name of the profile.
String Platform—The platform that manages the server.
String Option Download Image From—The location from where the image must be downloaded from.
String Server—The IP address of the server.
String File Path Name—The file path
String File Type—The file type.
String File Name—The name of the file.
String User Name—The user name.
String Password—The password
Boolean Map After Download—Map the .iso image after download
Boolean Delete All Images—Deletes all images on the server.
Boolean Run Upgrade After Download—Run upgrade immediately after downloading the image.
The CIMCHostImageProfileConfigId argument must be a valid profile name. If no argument is specified, all Host Image Mapping Profile configured in the system will be returned.
Modify Host Image Profile using an image that is present on a network location
The Host Image must be present in the network location.
/cloupia/api-v2/HostImageNetworkUpdateImageThe parameters of the HostImageNetworkUpdateImage API are:
String Profile Name—The unique name of the profile.
String Platform—The platform that manages the server.
String Option Download Image From—The location from where the image must be downloaded from.
String Server—The IP address of the server.
String File Path Name—The file path
String File Type—The file type.
String File Name—The name of the file.
String User Name—The user name.
String Password—The password
Boolean Map After Download—Map the .iso image after download
Boolean Delete All Images—Deletes all images on the server.
Boolean Run Upgrade After Download—Run upgrade immediately after downloading the image.
<cuicOperationRequest>
<operationType>MODIFY_HOST_IMAGE_PROFILE</operationType>
<payload>
<![CDATA[
<HostImageNetworkUpdateImage>
<profileName>sample</profileName>
<platform>EN120S M2</platform>
<option>FTP Server</option>
<server>10.10.10.10</server>
<pathFileName>/var/sample_path</pathFileName>
<fileType>ISO</fileType>
<fileName>huu.iso</fileName>
<!-- Set this value only when option not equals to any of {HTTP Server,HTTPS Server,} -->
<username>admin</username>
<!-- Set this value only when option not equals to any of {HTTP Server,HTTPS Server,} -->
<password>YWRtaW4=</password>
<!-- Set this value only when fileType not equals to any of {CIMC,BIOS,} -->
<mapAfterDownload>true</mapAfterDownload>
<deleteAllImages>true</deleteAllImages>
<upgradeNow>true</upgradeNow>
</HostImageNetworkUpdateImage>
]]>
</payload>
</cuicOperationRequest>
Profile is a mandatory field and it must be unique. Platform, Download Image From, Server IP Address, File Path and File Name are also mandatory fields.
Run a Host Image Upgrade on one or more servers using an already configured Host Image Profile.
The Host Image Profile must be already configured and must contain a valid Host Image.
/cloupia/api-v2/RunHostImageUpgradeThe parameters of the RunHostImageUpgrade API are:
String Profile Name—The unique name of the profile.
String Platform—The platform that manages the server.
String Image Version—The image version.
String File Type—The file type.
String Image Path—The path to the image.
String Servers—The servers on which the firmware must be upgraded.
Boolean Enable Schedule—The option to schedule the firmware upgrade to a later time.
String Schedule Name—The name of the schedule.
<cuicOperationRequest>
<operationType>RUN_HOST_IMAGE_UPGRADE</operationType>
<payload>
<![CDATA[
<RunHostImageUpgrade>
<profileName>sample_profile</profileName>
<platform>EN120S M2</platform>
<imageVersion>CIMC_3.2.4.bin</imageVersion>
<fileType>CIMC</fileType>
<imagePath>10.105.219.218/opt/infra/uploads/external/downloads/dir1529291857206/CIMC_3.2.4.bin</imagePath>
<servers>10.65.183.87;10.65.183.87</servers>
<enableSchedule>false</enableSchedule>
<!-- Set this value only when enableSchedule not equals to false -->
<associatedScheduleName></associatedScheduleName>
</RunHostImageUpgrade>
]]>
</payload>
</cuicOperationRequest>
Profile Name is mandatory, must be a valid existing profile. The serverIdKey must consist of a comma-separated list of Ids. Each Id is of the format: {AccountName};{ServerIPAddress}. In case of schedule option, a valid schedule name must be provided.
Download an ISO image to Micro SD cards or FlexFlash cards. You can also choose to initiate the upgrade immediately after the image is downloaded.
Rack accounts are created in the system.
/cloupia/api-v2/CIMCSDImageDownloadConfigThe parameters of the DOWNLOAD_IMAGE_SD API are:
downloadFrom—Download image from either local or network location. (String, mandatory)
localProfile—Select profile. Set this value only when downloadFrom parameter is not set to Network. (String, mandatory)
networkProfile—Select profile. Set this value only when downloadFrom parameter is not set to Local. (String, mandatory)
runUpgradeNow—Run upgrade after download. (boolean, optional)
servers—Comma-separated list of server IDs. Each ID is of the format: {AccountName};{ServerIPAddress}.Servers (String, mandatory)
<cuicOperationRequest>
<operationType>DOWNLOAD_IMAGE_SD</operationType>
<payload>
<![CDATA[
<CIMCSDImageDownloadConfig>
<downloadFrom>LOCAL</downloadFrom>
<!-- Set this value only when downloadFrom not equals to NETWORK -->
<localProfile>cco_c220_M4</localProfile>
<!-- Set this value only when downloadFrom not equals to LOCAL -->
<networkProfile></networkProfile>
<runUpgradeNow>false</runUpgradeNow>
<servers>10.10.10.10;10.11.111.111</servers>
</CIMCSDImageDownloadConfig>
]]>
</payload>
</cuicOperationRequest>Profile Name is mandatory, must have a valid existing profile for a Local Image or a network image. The image should not be already downloading.
Run a firmware upgrade on one or more servers using ISO images downloaded on Micro SD cards or FlexFlash cards.
The firmware image is downloaded.
/cloupia/api-v2/CIMCSDRunFirmwareUpgradeThe parameters of the RUN_UPGRADE_SD API are:
Servers—Servers on which the firmware must be upgraded. (String, mandatory)
enableSchedule—To schedule the firmware upgrade at a later point in time. (boolean, mandatory)
String associatedScheduleName—Name of the associate schedule.
<cuicOperationRequest>
<operationType>RUN_UPGRADE_SD</operationType>
<payload>
<![CDATA[
<CIMCSDRunFirmwareUpgrade>
<servers>10.10.10.10;10.11.11.11</servers>
<enableSchedule>false</enableSchedule>
<!-- Set this value only when enableSchedule not equals to false -->
<associatedScheduleName></associatedScheduleName>
</CIMCSDRunFirmwareUpgrade>
]]>
</payload>
</cuicOperationRequest>
The serverIdKey must consist of a comma-separated list of IDs. Each ID is of the format: {AccountName};{ServerIPAddress}.
If you choose the schedule option, then you must provide a valid schedule name.
Get status on the download and upgrade process of an ISO image to Micro SD cards or FlexFlash cards for specific servers using the IP address of the servers.
None
/cloupia/api-v2/CIMCSDImageDownloadStatusByServerIP/{CIMCSDImageDownloadStatusByServerIPId}The CIMCSDImageDownloadStatusByServerIPId argument must be a valid IP address of a server. If no argument is specified, status of all image download/upgrade operations is returned.
The dots in the IP address must be substituted with an underscore.
Get status on the download and upgrade process of an ISO image to Micro SD cards or FlexFlash cards for specific servers using the account name of the servers.
None
/cloupia/api-v2/CIMCSDImageDownloadStatusByAccountName/{CIMCSDImageDownloadStatusByAccountNameId}The CIMCSDImageDownloadStatusByAccountNameId argument must be a valid account name of a server. If no argument is specified, status for all image download and upgrade operations is returned.
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/CIMCEmailAlertRuleConfigThe 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 for which email alerts are sent.
String emailAddress—The email addresses 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/CIMCEmailAlertRuleConfigThe 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[
<CIMCEmailAlertRuleConfig>
<name></name>
<alertLevel>SYSTEM</alertLevel>
<!-- Set this value only when alertLevel not equals to SYSTEM -->
<serverGroups></serverGroups>
<servers></servers>
<emailAddress></emailAddress>
<severity></severity>
<enabled>false</enabled>
</ModifyEmailAlertRuleConfig>
]]>
</payload>
</CIMCEmailAlertRuleConfig>Rule name cannot be modified.
Delete one or more existing Email Alert Rules.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfigString emailAlertRules—The email alert rule.
<cuicOperationRequest>
<operationType>EMAIL_ALERT_RULE_DELETE</operationType>
<payload>
<![CDATA[
<EmailAlertRuleConfig>
<emailAlertRules></emailAlertRules>
</EmailAlertRuleConfig>
]]>
</payload>
</cuicOperationRequest>Comma separated list of rule names, all of which must be of valid existing rules.
This task allows the user to enable one or more existing Email Alert Rules.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfigThe parameters of the EMAIL_ALERT_RULE_ENABLE API are:
String emailAlertRuleNames—The name for the email alert.
<cuicOperationRequest>
<operationType>EMAIL_ALERT_RULE_ENABLE</operationType>
<payload>
<![CDATA[
<CIMCEmailAlertRuleConfig>
<emailAlertRuleNames></emailAlertRuleNames>
</CIMCEmailAlertRuleConfig>
]]>
</payload>
</cuicOperationRequest>Comma separated list of rule names, all of which must be valid existing rules.
Disabling Email Alert Rules
This task allows the user to disable one or more existing Email Alert Rules.
None
/cloupia/api-v2/CIMCEmailAlertRuleConfigThe parameters of the EMAIL_ALERT_RULE_DISABLE API are:
String emailAlertRuleNames—The names for the email alert.
<cuicOperationRequest>
<operationType>EMAIL_ALERT_RULE_DISABLE</operationType>
<payload>
<![CDATA[
<CIMCEmailAlertRuleConfig>
<emailAlertRuleNames></emailAlertRuleNames>
</CIMCEmailAlertRuleConfig>
]]>
</payload>
</cuicOperationRequest>Comma separated list of rule names, all of which must be of valid existing rules.
Enabling Email Alert Rule
This task allows the user to create a new schedule.
None
/cloupia/api-v2/ImcsManageScheduleConfigThe parameters of the SCHEDULE_CREATE API are:
String scheduleName—Name of the schedule task.
Boolean enableSchedule—Enable the tasks associated with the schedule.
String scheduleType—A one time or recurring schedule frequency.
Long scheduleTime—Optional. A schedule time.
String currentSystemTime—Optional. The system time.
String daysSchedule—Optional. Number of days to set the schedule time.
String hoursSchedule—Optional. Number of hours to set the schedule time.
String minutesSchedule—Optional. Number of minutes to set the schedule time.
<cuicOperationRequest>
<operationType>SCHEDULE_CREATE</operationType>
<payload>
<![CDATA[
<ImcsManageScheduleConfig>
<scheduleName></scheduleName>
<enableSchedule>true</enableSchedule>
<scheduleType>One Time</scheduleType>
<!-- Set this value only when scheduleType not equals to Recurring -->
<!-- Accepts value from the list: date_time-->
<scheduleTime>1462353000000</scheduleTime>
<!-- Set this value only when scheduleType not equals to Recurring -->
<currentSystemTime></currentSystemTime>
<!-- Set this value only when scheduleType equals to Recurring -->
<daysSchedule>0</daysSchedule>
<!-- Set this value only when scheduleType equals to Recurring -->
<hoursSchedule>0</hoursSchedule>
<!-- Set this value only when scheduleType equals to Recurring -->
<minutesSchedule>5</minutesSchedule></ImcsManageScheduleConfig>]]>
</payload>
</cuicOperationRequest>
Schedule Name is mandatory and must be unique. In case of a One-Time schedule, the date or time must be a future date or time. In case of a Recurring schedule, both hours and minutes cannot be set to zero.
This task allows the user to query the details of one or more existing schedules.
None
/cloupia/api-v2/ImcsManageScheduleConfig/{ImcsManageScheduleConfigId}The Id argument must be a valid schedule name. If no argument is specified, all schedules configured in the system will be returned.
This task allows the user to update an existing schedule.
None
/cloupia/api-v2/ImcsManageScheduleConfigThe parameters of the SCHEDULE_UPDATE API are:
String scheduleName—Name of the schedule task.
Boolean enableSchedule—Enable the tasks associated with the schedule.
String scheduleType—A one time or recurring schedule frequency.
Long scheduleTime—Optional. A schedule time.
String currentSystemTime—Optional. The system time.
String daysSchedule—Optional. Number of days to set the schedule time.
String hoursSchedule—Optional. Number of hours to set the schedule time.
String minutesSchedule—Optional. Number of hours to set the schedule time.
<cuicOperationRequest><operationType>SCHEDULE_UPDATE</operationType>
<payload>
<![CDATA[<ImcsManageScheduleConfig>
<scheduleName></scheduleName>
<enableSchedule>true</enableSchedule>
<scheduleType>One Time</scheduleType>
<!-- Set this value only when scheduleType not equals to Recurring -->
<!-- Accepts value from the list: date_time-->
<scheduleTime>1462354500000</scheduleTime>
<!-- Set this value only when scheduleType equals to Recurring -->
<daysSchedule>0</daysSchedule>
<!-- Set this value only when scheduleType equals to Recurring -->
<hoursSchedule>0</hoursSchedule>
<!-- Set this value only when scheduleType equals to Recurring -->
<minutesSchedule>5</minutesSchedule>
</ImcsManageScheduleConfig>]]></payload></cuicOperationRequest>
Schedule Name is mandatory and must refer to an existing schedule and cannot be changed. In case of a One-Time schedule, the date and time must be a future date and time. In case of a Recurring schedule, both hours and minutes cannot be set to zero.
This task allows the user to delete one or more existing schedules.
None
/cloupia/api-v2/ImcsManageScheduleConfigThe parameters of the SCHEDULE_DELETE API are:
String scheduleNames—Name of the schedule task.
<cuicOperationRequest>
<operationType>SCHEDULE_DELETE</operationType>
<payload>
<![CDATA[<ImcsManageSchedulesConfig>
<scheduleNames></scheduleNames></ImcsManageSchedulesConfig>]]>
</payload>
</cuicOperationRequest>
Schedule Names must be a comma-separated string of one or more existing schedules.
This task allows the user to enable one or more existing schedules.
None
/cloupia/api-v2/EnableSchedulesThe parameters of the SCHEDULE_ENABLE API are:
String scheduleNames—Names of the schedule task.
<cuicOperationRequest>
<operationType>SCHEDULE_ENABLE</operationType>
<payload>
<![CDATA[<ImcsManageSchedulesConfig>
<scheduleNames></scheduleNames></ImcsManageSchedulesConfig>]]>
</payload>
</cuicOperationRequest>
Schedule Names must be a comma-separated string of one or more existing schedules.
This task allows the user to disable one or more existing schedules.
None
/cloupia/api-v2/DisableSchedulesThe parameters of the SCHEDULE_DISABLE API are:
String scheduleNames—Names of the schedule task.
<cuicOperationRequest>
<operationType>SCHEDULE_DISABLE</operationType>
<payload>
<![CDATA[<ImcsManageSchedulesConfig>
<scheduleNames></scheduleNames>
</ImcsManageSchedulesConfig>]]>
</payload>
</cuicOperationRequest>
Schedule Names must be a comma-separated string of one or more existing schedules.
This task allows the user to query the details of one or more existing schedules. The Id argument must be one of the two Schedule Types - One Time or Recurring. If no argument is specified, all schedules configured in the system will be returned.
None
/cloupia/api-v2/ScheduleByType/{ScheduleByTypeId}The Id argument must be one of the two Schedule Types - One Time or Recurring. If no argument is specified, all schedules configured in the system will be returned.
This task allows the user to query the details of scheduled discovery tasks for a given schedule. The Id argument must be a valid schedule name. If no argument is specified, all scheduled discovery tasks configured in the system will be returned.
None
/cloupia/api-v2/DiscoveryScheduleTasksBySchedule/{DiscoveryScheduleTasksByScheduleId}The Id argument must be a valid schedule name. If no argument is specified, all scheduled discovery tasks configured in the system will be returned.
This task allows the user to query the details of scheduled discovery tasks for a given profile.
None
/cloupia/api-v2/DiscoveryScheduleTasksByProfile/{DiscoveryScheduleTasksByProfileId}This task allows the user to query the details of scheduled firmware upgrade tasks for a given schedule.
None
/cloupia/api-v2/FirmwareScheduleTasksBySchedule/{FirmwareScheduleTasksByScheduleId}The Id argument must be a valid Schedule name. If no argument is specified, all scheduled firmware upgrade tasks configured in the system will be returned.
This task allows the user to query the details of scheduled firmware upgrade tasks for a given profile.
None
/cloupia/api-v2/FirmwareScheduleTasksByProfile/{FirmwareScheduleTasksByProfileId}The Id argument must be a valid profile name. If no argument is specified, all scheduled firmware upgrade tasks configured in the system will be returned.
This task allows the user to query the details of scheduled policy tasks for a given schedule.
None
/cloupia/api-v2/PolicyScheduleTasksByScheduleName/{PolicyScheduleTasksByScheduleNameId}The Id argument must be a valid schedule name. If no argument is specified, all scheduled policy tasks configured in the system will be returned.
This task allows the user to query the details of scheduled policy tasks for a given policy.
None
/cloupia/api-v2/PolicyScheduleTasksByPolicyName/{PolicyScheduleTasksByPolicyNameId}The Id argument must be a valid policy name. If no argument is specified, all scheduled policy tasks configured in the system will be returned.
This task allows the user to query the details of scheduled profile tasks for a given schedule.
None
/cloupia/api-v2/ProfileScheduleTasksByScheduleName/{ProfileScheduleTasksByScheduleNameId}The Id argument must be a valid schedule name. If no argument is specified, all scheduled profile tasks configured in the system will be returned.
This task allows the user to query the details of scheduled profile tasks for a given profile.
None
/cloupia/api-v2/ScheduledTasksByProfileName/{ScheduledTasksByProfileNameId}The Id argument must be a valid profile name. If no argument is specified, all scheduled policy tasks configured in the system will be returned.
Managing Policy and Profile Tasks
The examples in this category consist of various policy and profile management tasks on Cisco IMC Supervisor. These include creating, reading, updating, and deleting policies and profiles.
This task allows the user to create a hardware policy.
None
/cloupia/api-v2/CIMCHardwarePolicyThe parameters of the HARDWARE_POLICY_CREATE API are:
String policyName—The name of the policy.
String policyType—The hardware policy type.
String modular—The Cisco UCS C3260 modular dense storage rack server.
String policyDefinition—The policy definition.
<cuicOperationRequest>
<operationType>HARDWARE_POLICY_CREATE</operationType>
<payload>
<![CDATA[
<CIMCHardwarePolicy>
<policyName></policyName>
<policyType>BIOS Policy</policyType>
<modular>false</modular>
<policyDefinition></policyDefinition>
</CIMCHardwarePolicy>
]]>
</payload>
</cuicOperationRequest>The hardware policy name must be unique, containing valid policy type and definition. Enable 'Cisco UCS C3260' for modular, dense storage rack server with dual server nodes. The policy definition can either be obtained from the management guide or can be obtained by exporting policy from an already created one on the appliance.
A policy must be available in the Cisco IMC Supervisor appliance.
| Step 1 |
From the menu bar, choose Policies > Manage Policies and Profiles. |
| Step 2 |
Choose the Hardware Policies tab. |
| Step 3 |
Select an existing policy and click Export. |
| Step 4 |
In the Export dialog box, copy the XML Encoded Format. |
| Step 5 |
Click Close. |
| Step 6 |
From the menu bar, choose Policies > API and Orchestration. |
| Step 7 |
In the left pane, select Policy and Profile Tasks. |
| Step 8 |
Double-click HARDWARE_POLICY_CREATE or HARDWARE_POLICY_UPDATE operation. |
| Step 9 |
Enter Policy Name and select the Policy Type to create a policy or modify the existing policy details. |
| Step 10 |
Check the Cisco UCS C3260 check box if you need to create a Cisco UCS C3260 Rack Server policy. For more information about the various rack mount server policies and chassis policies see, Managing Cisco UCS C3260 Dense Storage Rack Server in the Cisco IMC Supervisor Rack-Mount Servers Management Guide. |
| Step 11 |
Paste the copied XML Encoded Format in the Policy Definition box. |
| Step 12 |
Click Generate XML. |
| Step 13 |
Click Execute REST API. |
| Step 14 |
Click Close. |
This task allows the user to update existing hardware policy.
None
/cloupia/api-v2/CIMCHardwarePolicyThe parameters of the HARDWARE_POLICY_UPDATE API are:
String policyName—The name of the policy.
String policyType—The hardware policy type.
String modular—The Cisco UCS C3260 modular dense storage rack server.
String policyDefinition—The policy definition.
<cuicOperationRequest>
<operationType>HARDWARE_POLICY_UPDATE</operationType>
<payload>
<![CDATA[
<CIMCHardwarePolicy>
<policyName></policyName>
<policyType>BIOS Policy</policyType>
<modular>false</modular>
<policyDefinition></policyDefinition>
</CIMCHardwarePolicy>
]]>
</payload>
</cuicOperationRequest>The hardware profile name must be an existing one, containing comma separated list of valid policies.
This task allows the user to apply hardware policies on one more servers.
None
/cloupia/api-v2/CIMCHardwarePolicyThe parameters of the HARDWARE_POLICY_APPLY API are:
String policyName—The name of the policy to apply.
String servers—The servers to which you want to apply the policy.
String chassis—The C3260 server to which you want to apply the policy.
boolean enableSchedule—Enable a schedule.
String associatedScheduleName—The associated schedule name.
<cuicOperationRequest>
<operationType>HARDWARE_POLICY_APPLY</operationType>
<payload>
<![CDATA[<CIMCHardwarePolicy>
<policyName></policyName>
<servers></servers>
<chassis></chassis>
<enableSchedule>false</enableSchedule> <!-- Set this value only when enableSchedule not equals to
false -->
<associatedScheduleName></associatedScheduleName>
</CIMCHardwarePolicy>]]>
</payload>
</cuicOperationRequest>Selected policy must be a valid one. The servers argument must consist of a comma-separated list of Id's. Each Id is in the format: {AccountName};{ServerIPAddress}. The chassis argument must consist of a comma-separated list of Id's. Each Id is in the format: {AccountName};{ChassisAddress}.
This task allows the user to delete one or more existing policies.
None
/cloupia/api-v2/CIMCHardwarePolicyThe parameters of the HARDWARE_POLICY_DELETE API are:
String policyNames—The name of the policy to delete.
<cuicOperationRequest>
<operationType>HARDWARE_POLICY_DELETE</operationType>
<payload>
<![CDATA[<CIMCHardwarePolicy>
<policyNames></policyNames>
</CIMCHardwarePolicy>]]>
</payload>
</cuicOperationRequest>Comma separated list of policies, all of which must be valid existing policies.
This task allows the user to query the details of Disk Group Policy.
None
/cloupia/api-v2/CIMCDiskGroupPolicyConfig/{CIMCDiskGroupPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all Disk Group policies created in the system will be returned.
This task allows the user to query the details of FlexFlash Policy.
None
/cloupia/api-v2/CIMCFFlashPolicyConfig/{CIMCFFlashPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all FlexFlash policies created in the system will be returned.
This task allows the user to query the details of IPMI Over LAN Policy.
None
/cloupia/api-v2/CIMCIpmiPolicyConfig/{CIMCIpmiPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all IPMI Over LAN policies created in the system will be returned.
This task allows the user to query the details of LDAP Policy.
None
/cloupia/api-v2/CIMCLdapConfig/{CIMCLdapConfigId}The Id argument must be a valid policy name. If no argument is specified, all LDAP policies created in the system will be returned.
This task allows the user to query the details of Legacy Boot Order Policy.
None
/cloupia/api-v2/CIMCBootOrderLegacyConfig/{CIMCBootOrderLegacyConfigId}The Id argument must be a valid policy name. If no argument is specified, all Legacy Boot Order policies created in the system will be returned.
This task allows the user to query the details of Network Security Policy.
None
/cloupia/api-v2/CIMCNetworkSecurityPolicyConfig/{CIMCNetworkSecurityPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all Network Security policies created in the system will be returned.
This task allows the user to query the details of NTP Policy.
None
/cloupia/api-v2/CIMCNtpPolicyConfig/{CIMCNtpPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all NTP policies created in the system will be returned.
This task allows the user to query the details of Password Expiration Policy.
None
/cloupia/api-v2/CIMCPasswordExpirationPolicyConfig/{CIMCPasswordExpirationPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all Password Expiration policies created in the system will be returned.
This task allows the user to query the details of the power restore policy.
None.
/cloupia/api-v2/CIMCPowerRestorePolicyConfig/{CIMCPowerRestorePolicyConfigId}The parameters of the CIMCPowerRestorePolicyConfig API are:
String Policy Name—The unique name of the policy.
String Value
String Note
The Id argument must be a valid policy name. If no argument is specified, all Power Restore policies created in the system will be returned.
This task allows the user to query the details of Boot Order Precision Policy.
None
/cloupia/api-v2/CIMCBootOrderPrecisionConfig/{CIMCBootOrderPrecisionConfigId}The Id argument must be a valid policy name. If no argument is specified, all Precision Boot Order policies created in the system will be returned.
This task allows the user to query the details of RAID Policy.
None
/cloupia/api-v2/CIMCRaidPolicyConfig/{CIMCRaidPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all RAID policies created in the system will be returned.
This task allows the user to query the details of Serial Over LAN Policy.
None
/cloupia/api-v2/CIMCSoLPolicyConfig/{CIMCSoLPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all Serial Over LAN policies created in the system will be returned.
This task allows the user to query the details of SNMP Policy.
None
/cloupia/api-v2/CIMCSNMPPolicyConfig/{CIMCSNMPPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all SNMP policies created in the system will be returned.
This task allows the user to query the details of SSH Policy.
None
/cloupia/api-v2/CIMCSshPolicyConfig/{CIMCSshPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all SSH policies created in the system will be returned.
This task allows the user to query the details of User Policy.
None
/cloupia/api-v2/CIMCUserPolicyConfig/{CIMCUsersConfigTableId}The Id argument must be a valid policy name. If no argument is specified, all User policies created in the system will be returned.
This task allows the user to query the details of vMedia Policy.
None
/cloupia/api-v2/CIMCVMediaPolicyConfig/{CIMCVMediaPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all vMedia policies created in the system will be returned.
This task allows the user to query the details of vKVM Policy.
None
/cloupia/api-v2/CIMCvKVMPolicyConfig/{CIMCvKVMPolicyConfigId}The Id argument must be a valid policy name. If no argument is specified, all vKVM policies created in the system will be returned.
This task allows the user to query the details of VIC Policy.
None
/cloupia/api-v2/CIMCVicPolicy/{CIMCVicPolicyId}The Id argument must be a valid policy name. If no argument is specified, all VIC policies created in the system will be returned.
This task allows the user to create a hardware profile.
None
/cloupia/api-v2/CIMCHardwareProfileThe parameters of the HARDWARE_PROFILE_CREATE API are:
String profileName—The name of the profile.
String policyIds—(Optional) The hardware policies created on the system.
boolean modular—(Optional) Cisco UCS C3260 dense storage rack server.
String nonmodularPolicies—If server is not a Cisco UCS C3260 dense storage rack server.
String modular Policies—If server policy is for a Cisco UCS C3260 dense storage rack server.
String targetPlatforms—The target platform of a server.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILE_CREATE</operationType>
<payload>
<![CDATA[<CIMCHardwareProfile>
<profileName></profileName>
<modular>false</modular>
<!-- Set this value only when modular not equals to true -->
<nonmodularPolicies></nonmodularPolicies>
<!-- Set this value only when modular not equals to false -->
<modularPolicies></modularPolicies>
<!-- Set this value only when modular not equals to false -->
<targetPlatforms></targetPlatforms>
</CIMCHardwareProfile>
]]>
</payload>
</cuicOperationRequest>The hardware profile name must be unique, containing comma separated list of valid policies. Enable 'Cisco UCS C3260' for dense storage rack server with dual server nodes. The policies must already exist in the appliance. The list of policies are specific to the selected server platform. The target platforms must be comma separated list of servers/chassis in the same sequence in which policies are specified.
This task allows the user to query the details of Hardware Profiles.
None
/cloupia/api-v2/CIMCHardwareProfile/{CIMCHardwareProfileId}The Id argument must be a valid profile name. If no argument is specified, all profiles created in the system will be returned.
This task allows the user to update existing hardware profile.
None
/cloupia/api-v2/CIMCHardwareProfileThe parameters of the HARDWARE_PROFILE_UPDATE API are:
String profileNames—The name of the profile.
String policyIds—(Optional) The hardware policies created on the system.
boolean modular—(Optional) Cisco UCS C3260 dense storage rack server.
String nonmodularPolicies—If server is not a Cisco UCS C3260 dense storage rack server.
String modular Policies—If server policy is for a Cisco UCS C3260 dense storage rack server.
String targetPlatforms—The target platform of a server.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILE_UPDATE</operationType>
<payload>
<![CDATA[
<CIMCHardwareProfile>
<profileName></profileName>
<modular>false</modular>
<!-- Set this value only when modular not equals to true -->
<nonmodularPolicies></nonmodularPolicies>
<!-- Set this value only when modular not equals to false -->
<modularPolicies></modularPolicies>
<!-- Set this value only when modular not equals to false -->
<targetPlatforms></targetPlatforms>
</CIMCHardwareProfile>
]]>
</payload>
</cuicOperationRequest>The hardware profile name must be an existing one, containing comma separated list of valid policies. Enable 'Cisco UCS C3260' for dense storage rack server with dual server nodes. The list of policies specified here will completely override any previous list of associated policies that was specified when this profile was created. The target platforms must be comma separated list of servers/chassis in the same sequence in which policies are specified.
This task allows the user to derive a hardware profile.
None.
/cloupia/api-v2/CIMCDeriveHardwareProfileThe parameters of the CIMCDeriveHardwareProfile API are:
String Profile Name—The unique name of the profile.
String Policy ID—The IDs of the profile.
Boolean Modular—For Cisco UCS S3260.
Boolean Manual—The server details entered manually.
String Choose Server—The server list.
String Server IP—The IP addresses of the server.
String Chassis—The chassis details. Applicable only when modular option is enabled.
Boolean Credential Policy—The option to use a credential policy.
String Credential Policy—The credential policy to be used.
String User Name—The user name.
String Password—The password.
String Protocol—The protocol to be used.
Port—The port to be used.
String Policy—The policy types.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILE_DERIVE</operationType>
<payload>
<![CDATA[
<CIMCDeriveHardwareProfile>
<profileName>sample</profileName>
<modular>true</modular>
<manual>false</manual>
<!-- Set this value only when manual not equals to true -->
<chooseServer></chooseServer>
<!-- Set this value only when manual not equals to false -->
<server></server>
<!-- Set this value only when manual not equals to true -->
<chooseChassis></chooseChassis>
<!-- Set this value only when manual not equals to false -->
<credentialPolicy>false</credentialPolicy>
<!-- Set this value only when manual not equals to false -->
<policy></policy>
<!-- Set this value only when manual not equals to false -->
<username></username>
<!-- Set this value only when manual not equals to false -->
<password></password>
<!-- Set this value only when manual not equals to false -->
<protocol>https</protocol>
<!-- Set this value only when manual not equals to false -->
<port>443</port>
<policyTypes>BIOS Policy</policyTypes>
</CIMCDeriveHardwareProfile>
]]>
</payload>
</cuicOperationRequest>
The hardware profile name must be unique, containing comma separated list of valid profiles. Enable Modular for modular, dense storage rack server with dual server nodes. Enter Server Details Manually - enable to manually input the server details. Choose Server - Choose the server from which the configurations are to be retrieved. Choose Chassis - Choose the chassis from which the configurations are to be retrieved. Choose Policies - Choose the policies to be created from the server.
This task allows the user to delete hardware profiles.
None
/cloupia/api-v2/CIMCHardwareProfileThe parameters of the HARDWARE_PROFILE_DELETE API are:
String profileNames—The name of the profile.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILE_DELETE</operationType>
<payload>
<![CDATA[<CIMCHardwareProfile>
<profileNames></profileNames></CIMCHardwareProfile>]]>
</payload>
</cuicOperationRequest>The hardware profiles name(s) must be existing ones.
This task allows the user to apply hardware profile.
None
/cloupia/api-v2/CIMCHardwareProfileThe parameters of the HARDWARE_PROFILE_APPLY API are:
String profileNames—The name of the profile to apply.
String servers—The servers to which you want to apply the profile.
String Chassis—The chassis groups to which you want to apply the profile.
boolean enableSchedule—Enable a schedule.
String associatedScheduleName—The associated schedule name.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILE_APPLY</operationType>
<payload>
<![CDATA[
<CIMCHardwareProfile>
<profileName></profileName>
<servers></servers>
<chassis></chassis>
<enableSchedule>false</enableSchedule>
<!-- Set this value only when enableSchedule not equals to false -->
<associatedScheduleName></associatedScheduleName>
</CIMCHardwareProfile>
]]>
</payload>
</cuicOperationRequest>The servers argument must consist of a comma-separated list of Id's. Each Id is in the format: {AccountName};{ServerIPAddress}. The ServerIPAddress must be a non CISCO C3260 UCS server. The chassis argument must consist of a comma-separated list of Id's. Each Id is in the format: {AccountName};{ChassisAddress}.
This task allows the user to query the apply status details of hardware policies.
None.
/cloupia/api-v2/CIMCPolicyApplyStatusByPolicyName/{CIMCPolicyApplyStatusByPolicyNameId}The parameters of the CIMCPolicyApplyStatusByPolicyName API are:
String Policy Name—The unique name of the profile.
String Policy Type—The type of policy.
String Server Address—The server address.
String Host Name—The host name of the server.
String Account Name—The name of the account.
String Last Message—The last message on the server.
Boolean Is Successful—The indication if the apply status is successful or not.
String Last Policy Update—The indication of the last policy update on the servers.
The ID argument must be a valid policy name. If no argument is specified, apply status of all policies created in the system will be returned.
This task allows the user to query the apply status details of Hardware Profiles.
None.
/cloupia/api-v2/CIMCProfileApplyStatusByProfileName/{CIMCProfileApplyStatusByProfileNameId}The parameters of the CIMCProfileApplyStatusByProfileName API are:
String Policy Name—The unique name of the profile.
String Policy Type—The type of policy.
String Server Address—The server address.
String Host Name—The host name of the server.
String Account Name—The name of the account.
String Last Message—The last message on the server.
Boolean Is Successful—The indication if the apply status is successful or not.
String Last Policy Update—The indication of the last policy update on the servers.
The ID argument must be a valid policy name. If no argument is specified, apply status of all policies created in the system will be returned.
This task allows the user to query the list of hardware profiles that are associated with a specific server.
None.
/cloupia/api-v2/AssociatedHardwareProfilesByServerThe parameters of the AssociatedHardwareProfilesByServer API are:
String Account Name—The name of the account.
<cuicOperationRequest>
<operationType>HARDWARE_PROFILES</operationType>
<payload>
<![CDATA[
<AssociatedHardwareProfilesByServer>
<servers>CIMC192;<ip_address of server></servers>
</AssociatedHardwareProfilesByServer>
]]>
</payload>
</cuicOperationRequest>The ID argument must be a valid rack server account name.
This task allows the user to query the list of servers that are associated with a specific hardware profile.
None.
/cloupia/api-v2/AssociatedServersByPolicyNameThe parameters of the AssociatedServersByPolicyName API are:
Boolean Modular—Cisco UCS S3260 server
String Non-modular Hardware Policy—The name of the hardware policy that is for non-modular servers.
String Modular Hardware Policy—The name of the hardware policy that is for a modular server.
<cuicOperationRequest>
<operationType>SERVER_PROFILES</operationType>
<payload>
<![CDATA[
<AssociatedServersByPolicyName>
<modular>false</modular>
<!-- Set this value only when modular not equals to true -->
<nonmodularPolicies>CIMC52(BIOS Policy)</nonmodularPolicies>
<!-- Set this value only when modular not equals to false -->
<modularPolicies></modularPolicies>
</AssociatedServersByPolicyName>
]]>
</payload>
</cuicOperationRequest>Specifying a hardware policy is mandatory.
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/CIMCRackGroupThe parameters of the RACK_GROUP_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.
<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></description>
<groupName>colusa</groupName></CIMCRackGroup><CIMCRackGroup><actionId>0</actionId>
<configEntryId>0</configEntryId><defaultGroup>false</defaultGroup><description></description>
<groupName>eseries</groupName></CIMCRackGroup><CIMCRackGroup><actionId>0</actionId>
<configEntryId>0</configEntryId><defaultGroup>false</defaultGroup>
<description>Test Rack Group 1</description>
<groupName>TestGroup</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/CIMCRackGroupThe parameters of the RACK_GROUP_UPDATE 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.
<cuicOperationRequest>
<operationType>RACK_GROUP_UPDATE</operationType>
<payload>
<![CDATA[
<CIMCRackGroup>
<groupName></groupName>
<description></description>
</CIMCRackGroup>
]]>
</payload>
</cuicOperationRequest>
Group name is mandatory and must be unique.
Delete one or more existing rack groups.
None
/cloupia/api-v2/CIMCRackGroupThe parameters of the RACK_GROUP_DELETE 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.
<cuicOperationRequest>
<operationType>RACK_GROUP_DELETE</operationType>
<payload>
<![CDATA[
<CIMCRackGroup>
<groupNames></groupNames>
<deleteRackAccountsInGroup>false</deleteRackAccountsInGroup>
</CIMCRackGroup>
]]>
</payload>
</cuicOperationRequest>
Comma separated list of group names, all of which must be of valid existing rack groups.
This task allows user to create a rack account.
None
/cloupia/api-v2/CIMCInfraAccountThe parameters of the RACK_ACCOUNT_CREATE API are:
String accountName—The account name.
String server—Optional. The server name.
String description—Optional. The description of the account.
Boolean credentialPolicy—Optional. Create a credential policy.
String policy—The policy name.
String username—The server login name.
String password—The server login password.
String protocol—Optional. Port for the configuration.
String port—The port number.
Boolean acceptCertificate—Optional. The option to accept certificate.
String rackGroup—The name of the rack group.
String contact—Optional. The contact number.
String location—Optional. The location address.
<cuicOperationRequest>
<operationType>RACK_ACCOUNT_CREATE</operationType>
<payload>
<![CDATA[<CIMCInfraAccount>
<accountName></accountName>
<server></server>
<description></description>
<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>
<rackGroup>apitest-ren</rackGroup>
<contact></contact>
<location></location>
</CIMCInfraAccount>]]>
</payload>
</cuicOperationRequest>
Account name is mandatory and must be unique. ServerIP is mandatory. Username/Password are mandatory.
This task allows the user to update an existing rack account.
None
/cloupia/api-v2/CIMCInfraAccountThe parameters of the RACK_ACCOUNT_UPDATE API are:
String accountName—The account name.
String server—Optional. The server name.
String description—Optional. The description of the account.
Boolean credentialPolicy—Optional. Create a credential policy.
String policy—The policy name.
String username—The server login name.
String password—The server login password.
String protocol—Optional. Port for the configuration.
String port—The port number.
Boolean acceptCertificate—Optional. The option to accept certificate.
String rackGroup—The name of the rack group.
String contact—Optional. The contact number.
String location—Optional. The location address.
<cuicOperationRequest><operationType>RACK_ACCOUNT_UPDATE</operationType><payload>
<![CDATA[<CIMCInfraAccount><accountName></accountName><server></server>
<description></description>
<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><rackGroup>apitest-ren</rackGroup><contact></contact><location></location>
</CIMCInfraAccount>]]>
</payload>
</cuicOperationRequest>
ServerIP cannot be changed.
This task allows user to delete one or more existing rack accounts.
None
/cloupia/api-v2/CIMCInfraAccountThe parameters of the RACK_ACCOUNT_DELETE API are:
String devices—The account to delete.
<cuicOperationRequest><operationType>RACK_ACCOUNT_DELETE</operationType>
<payload>
<![CDATA[<CIMCInfraAccount>
<devices></devices></CIMCInfraAccount>]]>
</payload>
</cuicOperationRequest>
Comma separated list of account names, all of which must be valid existing rack accounts.
This task allows user to run inventory on one or more servers.
None
/cloupia/api-v2/RunInventoryThe parameters of the RUN_INVENTORY API are:
String inventoryLevel—Optional. The inventory on rack account or rack group.
String serverGroups—The rack groups.
String servers—Optional. The rack server.
<cuicOperationRequest><operationType>RUN_INVENTORY</operationType>
<payload>
<![CDATA[
<RunInventory>
<inventoryLevel>RACK GROUP</inventoryLevel>
<!-- Set this value only when inventoryLevel not equals to RACK ACCOUNT -->
<serverGroups></serverGroups>
<!-- Set this value only when inventoryLevel not equals to RACK GROUP -->
<servers></servers></RunInventory>]]>
</payload>
</cuicOperationRequest>
Comma separated list of account names, all of which must be valid existing rack accounts or comma separated list of rack groups, all of which must be valid existing rack groups.
This task allows user to test connection to one or more servers.
None
/cloupia/api-v2/TestConnectionThe parameters of the TEST_CONNECTION API are:
String devices—The rack account to test connection.
<cuicOperationRequest><operationType>TEST_CONNECTION</operationType>
<payload>
<![CDATA[<TestConnection><devices></devices></TestConnection>]]>
</payload>
</cuicOperationRequest>
Account name is mandatory.
This task allows user to assign rack group to one or more servers.
None
/cloupia/api-v2/AssignRackGroupThe parameters of the ASSIGN_RACK_GROUP API are:
String servers—The rack account to assign to a rack group.
String serverGroup —The rack server group.
<cuicOperationRequest>
<operationType>ASSIGN_RACK_GROUP</operationType>
<payload><![CDATA[<AssignRackGroup><servers></servers>
<serverGroup></serverGroup></AssignRackGroup>]]>
</payload>
</cuicOperationRequest>
Comma separated list of account names, all of which must be valid existing rack accounts. Rack group is mandatory.
This task allows user to run diagnostics on one or more servers.
SCU image location and SCP User password are configured.
/cloupia/api-v2/RunServerDiagnosticsThe parameters of the RUN_SERVER_DIAGNOSTICS API are:
String selectProfile—The server profile.
String diagLevel—The server or rack group to run diagnostics.
String serverGroups—The rack server group.
String servers—The rack server.
<cuicOperationRequest>
<operationType>RUN_SERVER_DIAGNOSTICS</operationType>
<payload>
<![CDATA[
<CIMCDiagnosticsRunConfig>
<selectProfile></selectProfile>
<servers></servers>
</CIMCDiagnosticsRunConfig>
]]>
</payload>
</cuicOperationRequest>
The servers argument must consist of a comma-separated list of IDs. Each ID format is: {AccountName};{ServerIPAddress}. The serverGroups argument must consist of comma separated list of rack groups, all of which must be valid existing rack groups.
This task allows the user to query the status of diagnostics being run on a server based on Server IP.
None
/cloupia/api-v2/CIMCDiagnosticsStatusByServerIP/{CIMCDiagnosticsStatusByServerIPId}The CIMCDiagnosticsStatusByServerIPId argument must be a valid IP address. If no argument is specified, an empty set of results will be returned. The dots in the IP address must be substituted with an underscore.
This task allows the user to delete diagnostics report of one or more servers based on Server IP.
None
/cloupia/api-v2/DeleteServerDiagnosticsReportThe parameters of the DELETE_DIAGNOSTICS_REPORT API are:
String serverIPs—The diagnostics report to delete.
<cuicOperationRequest>
<operationType>DELETE_DIAGNOSTICS_REPORT</operationType>
<payload>
<![CDATA[<CIMCDeleteDiagnosticsReportConfig>
<serverIPs></serverIPs></CIMCDeleteDiagnosticsReportConfig>]]>
</payload>
</cuicOperationRequest>
The serverIP argument must be a valid IP address.
This task allows the user to add compute tag(s) to a rack server or chassis.
None
/cloupia/api-v2/ComputeTagsThe parameters of the COMPUTE_TAGS_DELETE API are:
String (optional) physicalComputeType—The compute type.
String rackServer—The rack server.
String chassis—The chassis.
String tags—The tag name.
<cuicOperationRequest>
<operationType>COMPUTE_TAGS_ADD</operationType>
<payload>
<![CDATA[
<ComputeTags>
<physicalComputeType>Rack Servers</physicalComputeType>
<!-- Set this value only when physicalComputeType equals to Rack Servers -->
<rackServer></rackServer>
<!-- Set this value only when physicalComputeType equals to Chassis -->
<chassis></chassis>
<tags></tags>
</ComputeTags>
]]>
</payload>
</cuicOperationRequest>
Rack Server or Chassis is mandatory. Tag Names are mandatory. Tag names are key value pairs separated with ';'. Example:- <TagName1>:<TagValue1>;<TagName2>:<TagValue2>
This task allows the user to delete compute tag(s) from a rack server or chassis.
None
/cloupia/api-v2/ComputeTagsThe parameters of the COMPUTE_TAGS_DELETE API are:
String (optional) physicalComputeType—The compute type.
String rackServer—The rack server.
String chassis—The chassis.
String tags—The tag name.
<cuicOperationRequest>
<operationType>COMPUTE_TAGS_DELETE</operationType>
<payload>
<![CDATA[
<ComputeTags>
<physicalComputeType>Rack Servers</physicalComputeType>
<!-- Set this value only when physicalComputeType equals to Rack Servers -->
<rackServer></rackServer>
<!-- Set this value only when physicalComputeType equals to Chassis -->
<chassis></chassis>
<tags></tags>
</ComputeTags>
]]>
</payload>
</cuicOperationRequest>
Comma separated list of tag names, all of which must be valid existing server tags.
This task allows the user to create tech support for a rack servers.
None
/cloupia/api-v2/CreateTechSupportThe parameters of the CREATE_TECH_SUPPORT API are:
String rackServers—The rack servers.
String destination—List of the Destination Types and the Options.
String option—The option to select network transfer type.
String server—The IP address or account name of the server on which the support data file should be stored.
String pathFileName—The path and filename that must be used when exporting the file to the remote server.
String username—The username the system should use to log in to the remote server.
String password—The password for the remote server username.
<cuicOperationRequest>
<operationType>CREATE_TECH_SUPPORT</operationType>
<payload>
<![CDATA[
<CreateTechSupport>
<rackServers></rackServers>
<destination>REMOTE</destination>
<!-- Set this value only when destination not equals to LOCAL -->
<option>SCP</option>
<!-- Set this value only when destination not equals to LOCAL -->
<server></server>
<!-- Set this value only when destination not equals to LOCAL -->
<pathFileName></pathFileName>
<!-- Set this value only when option not equals to TFTP -->
<username></username>
<!-- Set this value only when option not equals to TFTP -->
<password></password>
</CreateTechSupport>]]>
</payload>
</cuicOperationRequest>
Rack servers are mandatory. Destination type is mandatory. If destination type is 'LOCAL' then no other fields are required. If destination type is 'REMOTE' then the fields 'ServerIP/Host name' and 'Path and File name' needs to be entered. The fields 'username' and 'password' are not required if 'Network Type' is 'TFTP'.
This task allows the user to clear entry for one or more existing technical support logs.
None
/cloupia/api-v2/ClearTechSupportThe parameters of the CLEAR_TECH_SUPPORT API are:
String techsupportFileName—The name of the technical support log file.
<cuicOperationRequest>
<operationType>CLEAR_TECH_SUPPORT</operationType>
<payload>
<![CDATA[
<ClearTechSupport><techSupportFileName></techSupportFileName></ClearTechSupport>]]>
</payload>
</cuicOperationRequest>
Comma separated list of technical support names, all of which must be valid existing tech support log names.
None
/cloupia/api-v2/CIMCTechLogSupportStatusByServerIP/{CIMCTechLogSupportStatusByServerIPId}The CIMCTechLogSupportStatusByServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor. The dots in the IP address must be substituted with an underscore.
Create a discovery profile to use for discovering servers based on IP address and importing them.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfigString 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.
String description—Description of the account.
String contact—The contact number.
String location—The location address.
String rackGroup—The name of the rack group.
<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>
<!-- Set this value only when option not equals to CSV -->
<description></description>
<!-- Set this value only when option not equals to CSV -->
<contact></contact>
<!-- Set this value only when option not equals to CSV -->
<location></location>
<!-- Set this value only when option not equals to CSV -->
<rackGroup>Default Group</rackGroup>
</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/CIMCDeviceDiscoveryConfigString 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.
String description—Description of the account.
String contact—The contact number.
String location—The location address.
String rackGroup—The name of the rack group.
<cuicOperationRequest>
<operationType>DISCOVERY_PROFILE_UPDATE</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>
<!-- Set this value only when option not equals to CSV -->
<description></description>
<!-- Set this value only when option not equals to CSV -->
<contact></contact>
<!-- Set this value only when option not equals to CSV -->
<location></location>
<!-- Set this value only when option not equals to CSV -->
<rackGroup>Default Group</rackGroup>
</CIMCDeviceDiscoveryConfig>
]]>
</payload>
</cuicOperationRequest>Profile Name cannot be modified.
Delete one or more existing discovery profiles.
None
/cloupia/api-v2/CIMCDeviceDiscoveryConfigString profileNames—Optional. The name of the profile.
<cuicOperationRequest>
<operationType>DISCOVERY_PROFILE_DELETE</operationType>
<payload>
<![CDATA[
<CIMCDeviceDiscoveryConfig>
<profileNames></profileNames>
</CIMCDeviceDiscoveryConfig>
]]>
</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/CIMCAutoDiscoveryConfigString profileNames—The name of the profile.
boolean enableSchedule—Enable a schedule.
String associatedScheduleName—Name of the associate schedule.
<cuicOperationRequest>
<operationType>RUN_SERVER_DISCOVERY</operationType>
<payload>
<![CDATA[
<RunServerDiscovery>
<profileNames></profileNames>
<enableSchedule>false</enableSchedule>
<!-- Set this value only when enableSchedule not equals to false -->
<associatedScheduleName></associatedScheduleName>
</RunServerDiscovery>
]]>
</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/ImportRackServersString devices—The discovered devices.
String userPrefix—Optional. The prefix for the user.
<cuicOperationRequest>
<operationType>IMPORT_SERVER</operationType>
<payload>
<![CDATA[
<ImportRackServers>
<devices></devices>
<userPrefix></userPrefix>
</ImportRackServers>
]]>
</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/HardResetActionString serverIdKey—The server Id key.
<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/PowerCycleActionString serverIdKey—The server Id key.
<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/PowerOffActionString serverIdKey—The server Id key.
<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/PowerOnActionString serverIdKey—The server Id key.
<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/ShutDownActionString serverIdKey—The server Id key.
<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/SetLabelActionString serverIdKey—The server Id key.
String setLabel—The label name.
<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/LocatorLedActionString serverIdKey—The server Id key.
String locatorLed—The locator LED.
<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.
This task allows the user to query the server utilization history based on the last N days. The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180.
None
/cloupia/api-v2/CIMCServerUtilizationHistoryByDays/{CIMCServerUtilizationHistoryByDaysId}The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180.
This task allows the user to query the server utilization history based on the last N days for a specific server, based on account name. The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180. The AccountNameId argument must be a valid account name of a server being managed by Cisco IMC Supervisor.
None
/cloupia/api-v2/CIMCServerUtilizationHistoryByDays/{CIMCServerUtilizationHistoryByDaysId}
/AccountName/{AccountNameId}The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180. The AccountNameId argument must be a valid account name of a server being managed by Cisco IMC Supervisor.
This task allows the user to query the server utilization history based on the last N days for a specific server, based on server IP. The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180. The ServerIPId argument must be a valid IP address of a server being managed by Cisco IMC Supervisor.
None
/cloupia/api-v2/CIMCServerUtilizationHistoryByDays/{CIMCServerUtilizationHistoryByDaysId}
/ServerIP/{ServerIPId}The CIMCServerUtilizationHistoryByDaysId argument must be a number between 1 and 180. The ServerIPId 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.
This task allows the user to apply a host image profile on the E-Series server configured in the system which will download the image you entered in the selected servers.
One or more E-series server must be configured as Rack Accounts.
/cloupia/api-v2/HostImageMapThe parameters of the MAP_HOST_IMAGE API are:
String ServerIdKey—The server key.
String imageName—The name of the image that you want to map.
<cuicOperationRequest>
<operationType>MAP_HOST_IMAGE</operationType>
<payload>
<![CDATA[
<HostImageMap>
<serverIdKey></serverIdKey>
<imageName></imageName>
</HostImageMap>
]]>
</payload>
</cuicOperationRequest>
ServerIdKey format: {AccountName};{ServerIPAddress}.
This task allows the user to unmap an image on the E-Series server configured in the system.
One or more E _series server must be configured as Rack Accounts.
/cloupia/api-v2/UnmapHostImageMapThe parameters of the UNMAP_HOST_IMAGE API are:
String ServerIdKey—The server key
<cuicOperationRequest>
<operationType>UNMAP_HOST_IMAGE</operationType>
<payload>
<![CDATA[
<UnmapHostImageMap>
<serverIdKey></serverIdKey>
</UnmapHostImageMap>
]]>
</payload>
</cuicOperationRequest>
ServerIdKey format: {AccountName};{ServerIPAddress}.
This task allows you to delete an image on the E-Series Server configured in the system.
One or more E _series server must be configured as Rack Accounts.
/cloupia/api-v2/DeleteHostImageMapThe parameters of the DELETE_HOST_IMAGE API are:
String ServerIdKey—The server key
String imageNames—The image name that you want to delete.
<cuicOperationRequest>
<operationType>DELETE_HOST_IMAGE</operationType>
<payload>
<![CDATA[
<DeleteHostImageMap>
<serverIdKey></serverIdKey>
<imageNames></imageNames>
</DeleteHostImageMap>
]]>
</payload>
</cuicOperationRequest>
ServerIdKey format: {AccountName};{ServerIPAddress} is a mandatory field. imageNames is a mandatory field and can be comma (,) separated value.
This task allows the user to create a Hardware Compatibility List (HCL) profile on selected rack server(s) configured in the system.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/CIMCManageHCLProfileConfig/{CIMCHCLReportByProfileNameId}The parameters of the HCL_PROFILE_CREATE API are:
String profileName—Name of the profile.
String server—The HCL server.
String hclReportData—The HCL report data.
<cuicOperationRequest>
<operationType>HCL_PROFILE_CREATE</operationType>
<payload>
<![CDATA[
<CIMCManageHCLProfileConfig>
<profileName></profileName>
<server></server>
</CIMCManageHCLProfileConfig>
]]>
</payload>
</cuicOperationRequest>
The Select Profile argument is mandatory and must be unique. The Server(s) argument must consist of a comma-separated list of Ids. Each Id is of the format: {AccountName};{ServerIPAddress}.
This task allows the user to modify a Hardware Compatibility List (HCL) profile on selected rack server(s) configured in the system.
One or more servers must be configured as Rack Accounts.
/cloupia/api-v2/CIMCModifyHCLProfileConfigThe parameters of the HCL_PROFILE_UPDATE API are:
String profileName—Name of the profile.
String server—The server.
<cuicOperationRequest>
<operationType>HCL_PROFILE_UPDATE</operationType>
<payload>
<![CDATA[
<CIMCModifyHCLProfileConfig>
<profileName></profileName>
<server></server>
</CIMCModifyHCLProfileConfig>
]]>
</payload>
</cuicOperationRequest>
The Select Profile argument is mandatory and must be existing. The Server(s) argument must consist of a comma-separated list of Ids. Each Id is of the format: {AccountName};{ServerIPAddress}.
This task allows you to perform a Set OS Tag action on rack servers or rack groups configured in the system.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/SetHCLOSTagThe parameters of the CREATE API are:
String tagLevel—The tag level.
String serverGroups—The rack group.
String servers—The server.
String os—A valid OS vendor name.
String osVersion—A valid OS version name.
<cuicOperationRequest>
<payload>
<![CDATA[
<SetHCLOSTag>
<tagLevel>SERVERGROUP</tagLevel>
<!-- Set this value only when tagLevel not equals to SERVER -->
<serverGroups></serverGroups>
<!-- Set this value only when tagLevel not equals to SERVERGROUP -->
<servers></servers>
<os></os>
<osVersion></osVersion>
</SetHCLOSTag>
]]>
</payload>
</cuicOperationRequest>
Choose argument must either be Server or ServerGroup.
The Server(s) argument must consist of a comma-separated list of Ids. Each Id is of the format: {AccountName};{ServerIPAddress}.
The Server Group(s) argument must consist of a comma-separated list of Rack Group names.
The Operating System argument must be a valid OS vendor name.
The Operating System Version argument must be a valid OS version name.
This task allows the user to perform delete OS Tag action on rack servers or rack groups configured in the system.
None
/cloupia/api-v2/CIMCHCLTagByServerIP/{serverIP}The parameters of the HCL_TAG_DELETE API are:
String tagLevel—The tag level.
String serverGroups—The rack group.
String servers—The server.
<cuicOperationRequest>
<operationType>HCL_TAG_DELETE</operationType>
<payload>
<![CDATA[
<DeleteHCLOSTag>
<tagLevel>SERVERGROUP</tagLevel>
<!-- Set this value only when tagLevel not equals to SERVER -->
<serverGroups></serverGroups>
<!-- Set this value only when tagLevel not equals to SERVERGROUP -->
<servers></servers>
</DeleteHCLOSTag>
]]>
</payload>
</cuicOperationRequest>
Choose argument must either be Server or ServerGroup.
The Server(s) argument must consist of a comma-separated list of Ids. Each Id is of the format: {AccountName};{ServerIPAddress}.
The Server Group(s) argument must consist of a comma-separated list of Rack Group names.
This task allows the user to delete a Hardware Compatibility List (HCL) profile configured in the system.
None
/cloupia/api-v2/DeleteHCLProfileConfigThe parameters of the HCL_PROFILE_DELETE API are:
String profileName—Name of the profile.
<cuicOperationRequest>
<operationType>HCL_PROFILE_DELETE</operationType>
<payload>
<![CDATA[
<DeleteHCLProfileConfig>
<profileName></profileName>
</DeleteHCLProfileConfig>
]]>
</payload>
</cuicOperationRequest>
The Select Profile argument is mandatory and must be existing.
This task allows the user to retrieve OS Tag based on the IP address of the server.
None
/cloupia/api-v2/CIMCHCLTagByServerIP/{serverIP}The serverIP 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.
This task allows the user to retrieve OS Versions based on the Vendor Name provided as input.
None
/cloupia/api-v2/HCLOSVersionsByVendorName/{osVendor}The serverIP argument must be a valid IP Vendor Name available in Cisco IMC Supervisor.
This task allows the user to retrieve HCL Report based on the Profile Name.
None
/cloupia/api-v2/CIMCHCLReportByProfileName/{CIMCHCLReportByProfileNameId}The CIMCHCLReportByProfileNameId argument must be a valid Profile Name.
This task allows the user to retrieve HCL Report based on the rack group name.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/CIMCServerHCLReportByRackGroup/{CIMCServerHCLReportByRackGroupId}The CIMCServerHCLReportByRackGroupId argument must be a valid Rack Group name managed by Cisco IMC Supervisor. The dots in the IP address need to be substituted with an underscore.
This task allows the user to retrieve HCL Report based on the IP address of the server.
One or more Servers must be configured as Rack Accounts.
/cloupia/api-v2/CIMCServerHCLReportByServerIP/{CIMCServerHCLReportByServerIPId}The CIMCServerHCLReportByServerIPId 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/groupThe 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.
<cuicOperationRequest>
<payload>
<![CDATA[
<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>
]]>
</payload>
</cuicOperationRequest>
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/groupThe 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/groupThe 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/groupThe 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/groupThe 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/userThe 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>
<!-- Accepts value from the list: locale-->
<locale>en_US</locale>
</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/userThe 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>
<!-- Accepts value from the list: locale-->
<locale>en_US</locale>
</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/userThe 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/userThe 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/userThe 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/userThe parameters of the DISABLE_DATE API are:
String loginName—The login name for the user.
Long userExpiryDate—The expiry date set for the user.
<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/userThe parameters of the UPDATE_USER_PASSWORD API are:
String loginName—The login name for the user.
String password—The password for the user.
String confirmPassword—Repeat the password from the previous field.
<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.
Feedback