Chapter 1. Overview

Structure of an Example

How to Use the Examples

Chapter 2. Examples

Overview

Creating a Firmware Network Image

Updating Firmware Network Image

Finding Firmware Image

Creating a Firmware Local Image

Downloading Firmware Local Image

Deleting Firmware Image Profile

Running Firmware Upgrade

Reading Firmware Image by a Profile Name

Reading Firmware Image by Type

Reading Firmware Image by Platform

Reading Download Status by Profile Name

Reading Firmware Upgrade Status by Profile Name

Reading Firmware Upgrade Status by IP Address

Overview

Creating an Email Alert Rule

Reading an Email Alert Rule

Updating an Email Alert Rule

Deleting Email Alert Rules

Overview

Creating a User Group

Enabling All Users in a Group

Updating a User Group

Deleting a User Group

Creating a Discovery Profile

Reading a Discovery Profile

Updating a Discovery Profile

Deleting a Discovery Profile

Running Server Discovery

Reading Discovered Devices

Importing Discovered Devices

Hard Reset Server

Power Cycle Server

Power Off Server

Power On Server

Shutdown Server

Set Label on Server

Toggle Locator LED on Server

Reading Servers by Tag Name

Reading Servers by Tag Value

Reading Server Faults by DN

Reading Server Faults by IP Address

Reading Server Faults by Account Name

Reading Server Faults by Severity

Reading Server Faults by Fault Code

Reading Server Faults History by DN

Reading Server Faults History by IP Address

Reading Server Faults History by Account Name

Reading Server Faults History by Severity

Reading Server Faults History by Fault Code

Reading Servers by Product ID

Reading Servers by Account Name

Reading Servers by UUID

Reading Servers by Server IP

Reading Servers by Serial Number

Reading Servers by Rack Group

Reading Server Inventory by Account Name

Reading Server Inventory by Server IP

Reading Server Utilization by Account Name

Reading Server Utilization by Server IP

Reading Server Utilization History by Account Name

Reading Server Utilization History by Server IP

Overview

Creating a User Group

Updating a User Group

Deleting a User Group

Enabling All Users in a Group

Disabling All Users in a Group

Creating a User

Reading a User

Updating a User

Deleting a User

Enabling a User

Disabling a User

Updating a User Expiry Date

Updating a User Password

Preface

Audience

Conventions

Documentation Feedback

Obtaining Documentation and Submitting a Service Request

Related Documentation

Copyright Page

Chapter 1. Overview

This chapter contains the following sections:

- Structure of an Example

- How to Use the Examples

Structure of an Example

Under a descriptive title, each example comprises the following sections:

Objective

When you would use the example.

Prerequisites

What conditions have to exist for the example to work.

REST URL

What is the REST URL to pass the REST API.

Components

Which objects and methods are used in the example, and what the input variables represent.

Sample Input XML

The input code sample.

Implementation

Notes on implementing the example, including what modifications might be necessary to implement it.

See Also

Related examples

How to Use the Examples

This document is a collection of examples-recipes, if you will-for using REST API, a server-side scripting solution for use with Cisco IMC Supervisor. Like a cookbook, you can use this document in at least three ways:

- You can follow the examples as written (substituting your own variables, of course) to complete tasks without necessarily knowing everything about the steps you are following.

- You can use the examples as templates and adapt them to similar tasks in your work.

- You can study the examples to figure out “how things are done” in REST API and generalize to using different methods for other tasks you need to script.

The examples are chosen to illustrate common use cases and are intended to facilitate all three of these modes of use.

Note

An API uses either HTTP POST or GET. In the following examples, all the READ APIs are GET and others are POST.

Chapter 2. Examples

This chapter contains the following sections:

- Overview

- Creating a Firmware Network Image

- Updating Firmware Network Image

- Finding Firmware Image

- Creating a Firmware Local Image

- Downloading Firmware Local Image

- Deleting Firmware Image Profile

- Running Firmware Upgrade

- Reading Firmware Image by a Profile Name

- Reading Firmware Image by Type

- Reading Firmware Image by Platform

- Reading Download Status by Profile Name

- Reading Firmware Upgrade Status by Profile Name

- Reading Firmware Upgrade Status by IP Address

- Overview

- Creating an Email Alert Rule

- Reading an Email Alert Rule

- Updating an Email Alert Rule

- Deleting Email Alert Rules

- Overview

- Creating a User Group

- Enabling All Users in a Group

- Updating a User Group

- Deleting a User Group

- Creating a Discovery Profile

- Reading a Discovery Profile

- Updating a Discovery Profile

- Deleting a Discovery Profile

- Running Server Discovery

- Reading Discovered Devices

- Importing Discovered Devices

- Hard Reset Server

- Power Cycle Server

- Power Off Server

- Power On Server

- Shutdown Server

- Set Label on Server

- Toggle Locator LED on Server

- Reading Servers by Tag Name

- Reading Servers by Tag Value

- Reading Server Faults by DN

- Reading Server Faults by IP Address

- Reading Server Faults by Account Name

- Reading Server Faults by Severity

- Reading Server Faults by Fault Code

- Reading Server Faults History by DN

- Reading Server Faults History by IP Address

- Reading Server Faults History by Account Name

- Reading Server Faults History by Severity

- Reading Server Faults History by Fault Code

- Reading Servers by Product ID

- Reading Servers by Account Name

- Reading Servers by UUID

- Reading Servers by Server IP

- Reading Servers by Serial Number

- Reading Servers by Rack Group

- Reading Server Inventory by Account Name

- Reading Server Inventory by Server IP

- Reading Server Utilization by Account Name

- Reading Server Utilization by Server IP

- Reading Server Utilization History by Account Name

- Reading Server Utilization History by Server IP

- Overview

- Disabling All Users in a Group

- Creating a User

- Reading a User

- Updating a User

- Deleting a User

- Enabling a User

- Disabling a User

- Updating a User Expiry Date

- Updating a User Password

Overview

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.

Creating a Firmware Network Image

Objective

Create a firmware image in a network location.

Prerequisites

The HUU Image must be available in a network location - NFS/CIFS/HTTP.

REST URL

/cloupia/api-v2/CreateNetworkImage

Components

The parameters of the NETWORK_IMAGE_CREATE API are:

- String profileName—The unique name of the profile.

- String platform—The name of the platform.

- String networkServerType—Network File System (NFS), Common Internet File System (CIFS) or HTTP/S server types.

- String locationLink—A valid HTTP/HTTPS URL link for the image location.

- String networkPath—The network path.

- String sharePath—The network share path.

- String remoteFileName—A remote filename.

- String nwPathUserName—Optional. The network path user name.

- String nwPathPassword—Optional. The network path password.

- String mountOptions—Optional. The valid mount options.

Sample Input XML

<cuicOperationRequest>
<operationType>NETWORK_IMAGE_CREATE</operationType>
<payload>
<![CDATA[
<CreateNetworkImage>
<profileName></profileName>

<platform></platform>

<networkServerType>NFS</networkServerType>

<!-- Set this value only when networkServerType equals to HTTP  -->
<locationLink></locationLink>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<networkPath></networkPath>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<sharePath></sharePath>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<remoteFileName></remoteFileName>

<nwPathUserName></nwPathUserName>

<nwPathPassword></nwPathPassword>

<!-- Set this value only when networkServerType equals to CIFS  -->
<mountOptions></mountOptions>

</CreateNetworkImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_updating_firmware_netwrk_image_d122.html

r_deleting_firmware_image_profile_d126.html

Updating Firmware Network Image

Objective

Update a firmware image in a network location.

Prerequisites

The HUU Image must be available in a network location - NFS/CIFS/HTTP.

REST URL

/cloupia/api-v2/UpdateNetworkImage

Components

The parameters of the NETWORK_IMAGE_UPDATE API are:

- String imageId—The unique ID of the image.

- boolean platform—The platform that manages a server.

- String networkServerType—Network File System (NFS), Common Internet File System (CIFS) or HTTP/S server types.

- String locationLink—A valid HTTP/HTTPS URL link for the image location.

- String networkPath—The network path.

- String sharePath—The network share path.

- String remoteFileName—A remote filename.

- String nwPathUserName—Optional. The network path user name.

- String nwPathPasswprd—Optional. The network path password.

- String mountOptions—Optional. The valid mount options.

Sample Input XML

<cuicOperationRequest>
<operationType>NETWORK_IMAGE_UPDATE</operationType>
<payload>
<![CDATA[
<UpdateNetworkImage>
<imageId></imageId>

<platform></platform>

<networkServerType>NFS</networkServerType>

<!-- Set this value only when networkServerType equals to HTTP  -->
<locationLink></locationLink>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<networkPath></networkPath>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<sharePath></sharePath>

<!-- Set this value only when networkServerType not equals to HTTP  -->
<remoteFileName></remoteFileName>

<nwPathUserName></nwPathUserName>

<nwPathPassword></nwPathPassword>

<!-- Set this value only when networkServerType equals to CIFS  -->
<mountOptions></mountOptions>

</UpdateNetworkImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_creating_firmware_network_image_d121.html

r_deleting_firmware_image_profile_d126.html

Finding Firmware Image

Objective

Find a firmware image on cisco.com.

Prerequisites

The user must have a valid set of credentials to login to cisco.com and have access privileges for HUU ISO images.

REST URL

/cloupia/api-v2/FindFirmwareImage

Components

The parameters of the LOCAL_IMAGE_FIND API are:

- String platform—The name of the platform.

- String username—ISO share login user name.

- String password—ISO share login password.

- boolean enableProxy—Optional. Enable proxy configuration.

- String host—The host name for the proxy configuration.

- String port—Port for the proxy configuration.

- boolean enableProxyAuth—Optional. Enable proxy authentication.

- String proxyAuthUserName—Proxy username for the proxy authentication.

- String proxyAuthPassword—Password for the proxy username.

Sample Input XML

<cuicOperationRequest>
<operationType>LOCAL_IMAGE_FIND</operationType>
<payload>
<![CDATA[
<FindFirmwareImage>
<platform></platform>

<username></username>

<password></password>

<enableProxy>false</enableProxy>

<!-- Set this value only when enableProxy equals to true  -->
<host></host>

<!-- Set this value only when enableProxy equals to true  -->
<port>0</port>

<!-- Set this value only when enableProxy equals to true  -->
<enableProxyAuth>false</enableProxyAuth>

<!-- Set this value only when enableProxyAuth equals to true  -->
<proxyAuthUserName></proxyAuthUserName>

<!-- Set this value only when enableProxyAuth equals to true  -->
<proxyAuthPassword></proxyAuthPassword>

</FindFirmwareImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

Username/Password for cisco.com and platform are mandatory. The platform of a server that is already added into the system.

See Also

r_creating_firmware_local_image_d124.html

Creating a Firmware Local Image

Objective

Create a firmware image in a local location inside the appliance.

Prerequisites

The user must have a valid set of credentials to login to cisco.com and have access privileges for HUU ISO images. The HUU Image must be downloadable from cisco.com, and must be found using the FindFirmwareImage API.

REST URL

/cloupia/api-v2/CreateLocalImage

Components

The parameters of the LOCAL_IMAGE_CREATE API are:

- String profileName—The unique name of the profile.

- String platform—The name of the platform.

- String username—ISO share login user name.

- String password—ISO share login password.

- String availableImage—The available .iso image.

- boolean enableProxy—Optional. Enable proxy configuration.

- String host—The host name for the proxy configuration.

- String port—Port for the proxy configuration.

- boolean enableProxyAuth—Optional. Enable proxy authentication.

- String proxyAuthUserName—Proxy username for the proxy authentication.

- String proxyAuthPassword—Password for the proxy username.

- boolean acceptLicense—Accept license agreement.

- boolean downloadNow—download the .iso image immediately after adding a profile.

Sample Input XML

<cuicOperationRequest>
<operationType>LOCAL_IMAGE_CREATE</operationType>
<payload>
<![CDATA[
<CreateLocalImage>
<profileName></profileName>

<platform></platform>

<username></username>

<password></password>

<availableImage></availableImage>

<enableProxy>false</enableProxy>

<!-- Set this value only when enableProxy equals to true  -->
<host></host>

<!-- Set this value only when enableProxy equals to true  -->
<port>0</port>

<!-- Set this value only when enableProxy equals to true  -->
<enableProxyAuth>false</enableProxyAuth>

<!-- Set this value only when enableProxyAuth equals to true  -->
<proxyAuthUserName></proxyAuthUserName>

<!-- Set this value only when enableProxyAuth equals to true  -->
<proxyAuthPassword></proxyAuthPassword>

<acceptLicense>false</acceptLicense>

<downloadNow>false</downloadNow>

</CreateLocalImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

Profile Name is mandatory, must be unique. Username/Password for cisco.com and Platform are mandatory. The Platform must be that of a server already added into the system.

See Also

r_finding_firmware_image_d123.html

Downloading Firmware Local Image

Objective

Download an image from cisco.com for an already configured firmware image profile, into a local location inside the appliance.

Prerequisites

The firmware image profile must be already configured.

REST URL

/cloupia/api-v2/DownloadLocalImage

Components

The parameter of the LOCAL_IMAGE_DOWNLOAD API is:

- String profileName—The unique name of the profile.

Sample Input XML

<cuicOperationRequest>
<operationType>LOCAL_IMAGE_DOWNLOAD</operationType>
<payload>
<![CDATA[
<DownloadLocalImage>
<profileName></profileName>

</DownloadLocalImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

Profile Name is mandatory, must be a valid existing profile for a Local Image. The image should not be already downloading.

See Also

r_creating_firmware_local_image_d124.html

r_deleting_firmware_image_profile_d126.html

Deleting Firmware Image Profile

Objective

Delete one or more existing firmware image profiles.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFirmwareUpgradeConfig

Components

The parameters of the FIRMWARE_IMAGE_DELETE API are:

- String profileId—The unique ID of the profile.

Sample Input XML

<cuicOperationRequest>
<operationType>FIRMWARE_IMAGE_DELETE</operationType>
<payload>
<![CDATA[
<DeleteFirmwareImage>
<profileId></profileId>

</DeleteFirmwareImage>

]]>
</payload>
</cuicOperationRequest>

Implementation

Profile name is mandatory and must be unique. IP address search criteria is mandatory, but CSV File option is not supported through API.

See Also

r_creating_firmware_local_image_d124.html

r_creating_firmware_network_image_d121.html

r_updating_firmware_netwrk_image_d122.html

Running Firmware Upgrade

Objective

Run a firmware upgrade on one or more servers using an already configured firmware image profile.

Prerequisites

The firmware image profile must be already configured and must contain a valid HUU ISO Image.

REST URL

/cloupia/api-v2/UpgradeFirmWareConfig

Components

The parameters of the RUN_FIRMWARE_UPGRADE API are:

- String profileName—The unique name of the profile.

- 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.

Sample Input XML

<cuicOperationRequest>
<operationType>RUN_FIRMWARE_UPGRADE</operationType>
<payload>
<![CDATA[
<UpgradeFirmWareConfig>
<profileName></profileName>

<servers></servers>

<enableSchedule>false</enableSchedule>

<!-- Set this value only when enableSchedule not equals to false  -->
<associatedScheduleName></associatedScheduleName>

</UpgradeFirmWareConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_firmware_upgrade_status_profile_name_d132.html

r_firmware_upgrade_Status_ipaddress_d133.html

Reading Firmware Image by a Profile Name

Objective

Get Firmware Image By Profile Name

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFirmwareUpgradeConfig/{CIMCFirmwareUpgradeConfigId}

Implementation

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.

See Also

r_get_firmware_image_platform_d130.html

r_get_firmware_image_type_d129.html

Reading Firmware Image by Type

Objective

Get firmware image by type.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFirmwareImageByType/{CIMCFirmwareImageByTypeId}

Implementation

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.

See Also

r_get_firmware_image_platform_d130.html

r_get_firmware_image_profile_name_d128.html

Reading Firmware Image by Platform

Objective

Get firmware image by platform.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFirmwareImageByPlatform/{CIMCFirmwareImageByPlatformId}

Implementation

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.

See Also

r_get_firmware_image_profile_name_d128.html

r_get_firmware_image_type_d129.html

Reading Download Status by Profile Name

Objective

Image download status by profile name.

Prerequisites

None

REST URL

/cloupia/api-v2/LocalImageDownloadStatusByProfileName/{LocalImageDownloadStatusByProfileNameId

Implementation

This task allows the user to query the download status of a local firmware image based on the profile name The LocalImageDownloadStatusByProfileNameId argument must be a valid profile name. If no argument is specified, an empty set of results will be returned.

See Also

r_downloading_firmware_local_image_d125.html

Reading Firmware Upgrade Status by Profile Name

Objective

Firmware upgrade status by profile name.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFirmwareUpgradeStatusbyProfileName/{CIMCFirmwareUpgradeStatusbyProfileNameId}

Implementation

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.

See Also

r_running_firmware_upgrade_d127.html

r_firmware_upgrade_Status_ipaddress_d133.html

Reading Firmware Upgrade Status by IP Address

Objective

Firmware upgrade status by server IP address.

Prerequisites

None

REST URL

>/cloupia/api-v2/CIMCFirmwareUpgradeStatusbyServerIP/{CIMCFirmwareUpgradeStatusbyServerIPId}

Implementation

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.

See Also

r_running_firmware_upgrade_d127.html

r_firmware_upgrade_status_profile_name_d132.html

Overview

The examples in this category consists of managing email alert rules on Cisco IMC Supervisor.

Creating an Email Alert Rule

Objective

Create an email alert rule for notification of faults.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCEmailAlertRuleConfig

Components

The parameters of the EMAIL_ALERT_RULE_CREATE API are:

- String name—The name for the email alert.

- String alertLevel—The alert level.

- String serverGroups—Optional. The server groups to which email alerts are sent.

- String emailAddress—The email address of the intended recipients of the email alert.

- String severity—Fault severity levels for which email alerts will be sent.

- Boolean enabled—Optional. Enable email alerts to the configured email address.

Sample Input XML

<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>

Implementation

Rule name is mandatory and must be unique. Email addresses are mandatory.

See Also

Reading Email Alert Rules

Updating Email Alert Rules

Deleting Email Alert Rules

Reading an Email Alert Rule

Objective

Get details of email alert rules.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCEmailAlertRuleConfig/{CIMCEmailAlertRuleConfigId}

Implementation

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.

See Also

Creating Email Alert Rules

Updating Email Alert Rules

Deleting Email Alert Rules

Updating an Email Alert Rule

Objective

Update an existing email alert rule.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCEmailAlertRuleConfig

Components

The parameters of the EMAIL_ALERT_RULE_UPDATE API are:

- String emailAlertRule—The email alert rule.

- String alertLevel—The alert level.

- String serverGroups—Optional. The server groups to which email alerts are sent.

- String emailAddress—The email used to notify the group owner about the status of service requests and request approvals if necessary.

- String severity—Fault severity levels for which email alerts will be sent.

- Boolean enabled—Optional. Enable email alerts to the configured email address.

Sample Input XML

<cuicOperationRequest>
<operationType>EMAIL_ALERT_RULE_UPDATE</operationType>
<payload>
<![CDATA[
<ModifyEmailAlertRuleConfig>
<emailAlertRule></emailAlertRule>

<alertLevel>SYSTEM</alertLevel>

<!-- Set this value only when alertLevel not equals to SYSTEM  -->
<serverGroups></serverGroups>

<emailAddress></emailAddress>

<severity></severity>

<enabled>false</enabled>

</ModifyEmailAlertRuleConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Rule name cannot be modified.

See Also

Reading Email Alert Rules

Creating Email Alert Rules

Deleting Email Alert Rules

Deleting Email Alert Rules

Objective

Delete one or more existing Email Alert Rules.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCEmailAlertRuleConfig

Components

String emailAlertRule—The email alert rule.

Sample Input XML

<cuicOperationRequest>
<operationType>EMAIL_ALERT_RULE_DELETE</operationType>
<payload>
<![CDATA[
<DeleteEmailAlertRuleConfig>
<emailAlertRule></emailAlertRule>

</DeleteEmailAlertRuleConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Comma separated list of rule names, all of which must be of valid existing rules.

See Also

Reading Email Alert Rules

Creating Email Alert Rules

Updating Email Alert Rules

Overview

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.

Creating a User Group

Objective

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.

Prerequisites

None

REST URL

/cloupia/api-v2/group

Components

The parameters of the CREATE API are:

- String groupName—The name of the group or the customer organization.

- String groupDescription—Optional. The description of the group or the customer organization, if required.

- String parentGroup—Optional. The name of the parent group.

- String groupCode—Optional. A shorter name or code name for the group.

- String groupContact—The contact name for the group.

- String firstName—Optional. The first name of the group owner.

- String lastName—Optional. The last name of the group owner.

- String phone—Optional. The phone number of the group owner.

- String address—Optional. The address of the group owner.

- String groupSharePolicyId—Optional. The ID of group share policy for the users in this group.

- Boolean allowPrivateUsers—Optional. The option that allows creating users with exclusive access to their resources.

Sample Input XML

<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>

Implementation

The user group name is mandatory and must be unique. Contact Email is mandatory.

See Also

Modifying a Group

Deleting a Group

r_enable_all_users_group_d141.html

r_disable_all_users_group_d183.html

Enabling All Users in a Group

Objective

This task allows a user to enable all users which are assigned to a group.

Prerequisites

None

REST URL

/cloupia/api-v2/group

Components

The parameter of the ENABLE_ALL_USERS_IN_GROUP API is:

String groupName—The name of the group or the customer organization.

Sample Input XML

<cuicOperationRequest>
<operationType>ENABLE_ALL_USERS_IN_GROUP</operationType>
<payload>
<![CDATA[
<EnableAllUsersInGroupConfig>
<groupID></groupID>

</EnableAllUsersInGroupConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

The groupId tag is mandatory and must include the numeric ID of a valid existing group.

See Also

Creating a Group

Modifying a Group

Deleting a Group

r_disable_all_users_group_d183.html

Updating a User Group

Objective

This task allows a user to update an existing group, which denotes a related set of users.

Prerequisites

None

REST URL

/cloupia/api-v2/group

Components

The parameters of the UPDATE API are:

- String groupId—The id of the group or the customer organization.

- String groupDescription—Optional. The description of the group or the customer organization, if required.

- String parentGroup—Optional. The name of the parent group.

- String groupCode—Optional. A shorter name or code name for the group.

- String costCenter—Optional. The cost centr for the group.

- String groupContact—The contact name for the group.

- String firstName—Optional. The first name of the group owner.

- String lastName—Optional. The last name of the group owner.

- String phone—Optional. The phone number of the group owner.

- String address—Optional. The address of the group owner.

- String groupSharePolicyId—Optional. The ID of group share policy for the users in this group.

- Boolean allowPrivateUsers—Optional. The option that allows creating users with exclusive access to their resources.

Sample Input XML

<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>

Implementation

Name cannot be modified. The groupId tag is mandatory and must include the numeric ID of a valid existing group. Contact Email is mandatory.

See Also

Creating a Group

Deleting a Group

r_enable_all_users_group_d141.html

r_disable_all_users_group_d183.html

Deleting a User Group

Objective

This task allows a user to delete an existing group, which denotes a related set of users.

Prerequisites

None

REST URL

/cloupia/api-v2/group

Components

String groupName—The name of the group or the customer organization.

Sample Input XML

<cuicOperationRequest>
<operationType>DELETE_GROUP</operationType>
<payload>
<![CDATA[
<DeleteGroupConfig>
<groupID></groupID>

</DeleteGroupConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

The groupId tag is mandatory and must include the numeric ID of a valid existing group.

See Also

Creating a Group

r_enable_all_users_group_d141.html

r_enable_all_users_group_d141.html

r_disable_all_users_group_d183.html

Creating a Discovery Profile

Objective

Create a discovery profile to use for discovering servers based on IP address and importing them.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCDeviceDiscoveryConfig

Components

The parameters of the DISCOVERY_PROFILE_CREATE API are:

- String profileName—The name of the profile.

- boolean isRange—Optional. The range

- String option—The option.

- String ipList—List of IP addresses.

- String startRange—Valid beginning IP address.

- String endRange—Valid last IP address.

- String networkAddress—The network IP address.

- String subnetMask—The range of subnet mask.

- String csvFile—Search by csv file.

- boolean credentialPolicy—Optional. Create a credential policy.

- 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.

Sample Input XML

<cuicOperationRequest>
<operationType>DISCOVERY_PROFILE_CREATE</operationType>
<payload>
<![CDATA[
<CIMCDeviceDiscoveryConfig>
<profileName></profileName>

<option>IP</option>

<!-- Set this value only when option equals to IPLIST  -->
<ipList></ipList>

<!-- Set this value only when option equals to IP  -->
<startRange></startRange>

<!-- Set this value only when option equals to IP  -->
<endRange></endRange>

<!-- Set this value only when option equals to SUBNET  -->
<networkAddress></networkAddress>

<!-- Set this value only when option equals to SUBNET  -->
<subnetMask></subnetMask>

<!-- Set this value only when option equals to CSV  -->
<csvFile></csvFile>

<credentialPolicy>false</credentialPolicy>

<!-- Set this value only when credentialPolicy not equals to false  -->
<policy></policy>

<!-- Set this value only when credentialPolicy not equals to true  -->
<username></username>

<!-- Set this value only when credentialPolicy not equals to true  -->
<password></password>

<!-- Set this value only when credentialPolicy not equals to true  -->
<protocol>https</protocol>

<!-- Set this value only when credentialPolicy not equals to true  -->
<port>443</port>

</CIMCDeviceDiscoveryConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Profile Name is mandatory, must be unique. IP Address Search Criteria is mandatory, but CSV File option is not supported via API.

See Also

Updating a Discovery Profile

Deleting a Discovery Profile

Reading a Discovery Profile

Objective

Get discovery profiles details.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCDeviceDiscoveryConfig/{CIMCDeviceDiscoveryConfigId}

Implementation

The Id argument must be a valid profile name. If no argument is specified, all discovery profiles configured in the system will be returned.

See Also

Creating a Discovery Profile

Updating a Discovery Profile

Deleting a Discovery Profile

Updating a Discovery Profile

Objective

Update an existing discovery profile.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCDeviceDiscoveryConfig

Components

The parameters of the DISCOVERY_PROFILE_UPDATE API are:

- String profileName—The unique name of the profile.

- String option—The option.

- String ipList—List of IP addresses.

- String startRange—Valid beginning IP address.

- String endRange—Valid last IP address.

- String networkAddress—The network IP address.

- String subnetMask—The range of subnet mask.

- String csvFile—Search by csv file.

- boolean credentialPolicy—Optional. Create a credential policy.

- boolean policy—Optional. The policy name.

- String username—The server login name.

- String password—The server login password.

- String protocol—Optional. HTTP or HTTPS protocol.

- int port—The port number.

Sample Input XML

<cuicOperationRequest>
<operationType>DISCOVERY_PROFILE_UPDATE</operationType>
<payload>
<![CDATA[
<ModifyCIMCDeviceDiscoveryProfile>
<profileName></profileName>

<option>IP</option>

<!-- Set this value only when option equals to IPLIST  -->
<ipList></ipList>

<!-- Set this value only when option equals to IP  -->
<startRange></startRange>

<!-- Set this value only when option equals to IP  -->
<endRange></endRange>

<!-- Set this value only when option equals to SUBNET  -->
<networkAddress></networkAddress>

<!-- Set this value only when option equals to SUBNET  -->
<subnetMask></subnetMask>

<!-- Set this value only when option equals to CSV  -->
<csvFile></csvFile>

<credentialPolicy>false</credentialPolicy>

<!-- Set this value only when credentialPolicy not equals to false  -->
<policy></policy>

<!-- Set this value only when credentialPolicy not equals to true  -->
<username></username>

<!-- Set this value only when credentialPolicy not equals to true  -->
<password></password>

<!-- Set this value only when credentialPolicy not equals to true  -->
<protocol>https</protocol>

<!-- Set this value only when credentialPolicy not equals to true  -->
<port>443</port>

</ModifyCIMCDeviceDiscoveryProfile>

]]>
</payload>
</cuicOperationRequest>

Implementation

Profile Name cannot be modified.

See Also

Creating a Discovery Profile

Deleting a Discovery Profile

Deleting a Discovery Profile

Objective

Delete one or more existing discovery profiles.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCDeviceDiscoveryConfig

Components

The parameters of the DISCOVERY_PROFILE_DELETE API are:

- String profileName—Optional. The name of the profile.

Sample Input XML

<cuicOperationRequest>
<operationType>DISCOVERY_PROFILE_DELETE</operationType>
<payload>
<![CDATA[
<DeleteCIMCDeviceDiscoveryProfile>
<profileName></profileName>

</DeleteCIMCDeviceDiscoveryProfile>

]]>
</payload>
</cuicOperationRequest>

Implementation

Comma separated list of profile names, all of which must be of valid existing profiles.

See Also

Creating a Discovery Profile

Updating a Discovery Profile

Reading a Discovery Profile

Running Server Discovery

Objective

Run a Discovery operation to discovery servers based on IP addresses, using one or more configured Discovery Profiles.

Prerequisites

Discovery Profile must be configured.

REST URL

/cloupia/api-v2/CIMCAutoDiscoveryConfig

Components

The parameters of the RUN_SERVER_DISCOVERY API are:

- String profileNames—The name of the profile.

- boolean enableSchedule—Enable a schedule.

- String associatedScheduleName—Name of the associate schedule.

Sample Input XML

<cuicOperationRequest>
<operationType>RUN_SERVER_DISCOVERY</operationType>
<payload>
<![CDATA[
<CIMCAutoDiscoveryConfig>
<profileNames></profileNames>

<enableSchedule>false</enableSchedule>

<!-- Set this value only when enableSchedule not equals to false  -->
<associatedScheduleName></associatedScheduleName>

</CIMCAutoDiscoveryConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Comma-separated list of valid profile names. In case of schedule option, a valid schedule name must be provided.

See Also

Importing Discovered Devices

Reading Discovered Devices

Objective

Get discovered device details.

Prerequisites

One or more servers must have been discovered using a discovery profile

REST URL

/cloupia/api-v2/CIMCDiscoveredDevice/{CIMCDiscoveredDeviceId}/State/{StateId}

Implementation

The CIMCDiscoveredDeviceId argument must be a valid profile name, and must be mandatorily specified. The StateId argument must be one of {All, Imported, NotImported}.

Importing Discovered Devices

Objective

Import one or more discovered devices.

Prerequisites

One or more servers must have been discovered using a Discovery Profile.

REST URL

/cloupia/api-v2/ImportRackServersConfig

Components

The parameters of the IMPORT_SERVER API are:

- String devices—The discovered devices.

- String userPrefix—Optional. The prefix for the user.

- String description—Optional. Description for the user.

- String contact—Optional. Contact details of the user.

- String location—Optional. Address of the user.

- String rackGroup—Create rack group.

Sample Input XML

<cuicOperationRequest>
<operationType>IMPORT_SERVER</operationType>
<payload>
<![CDATA[
<ImportRackServersConfig>
<devices></devices>

<userPrefix></userPrefix>

<description></description>

<contact></contact>

<location></location>

<rackGroup>Default Group</rackGroup>

</ImportRackServersConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Comma-separated list of one or more valid server IP addresses, which have been discovered. Group name of an existing rack group.

See Also

Running Server Discovery

Hard Reset Server

Objective

Hard reset one or more servers.

Prerequisites

One or more Servers must be configured as Rack Accounts.

REST URL

/cloupia/api-v2/HardResetAction

Components

The parameters of the HARD_RESET_SERVER API are:

- String serverIdKey—The server Id key.

Sample Input XML

<cuicOperationRequest>
<operationType>HARD_RESET_SERVER</operationType>
<payload>
<![CDATA[
<HardResetServer>
<serverIdKey></serverIdKey>

</HardResetServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress }

See Also

Power Cycle Server

Power On Server

Power Off Server

Shutdown Server

Set Label on Server

Toggle Locator LED on Server

Power Cycle Server

Objective

Power cycle one or more servers.

Prerequisites

One or more servers must be configured as rack accounts.

REST URL

/cloupia/api-v2/PowerCycleAction

Components

The parameters of the POWER_CYCLE_SERVER API are:

- String serverIdKey—The server Id key.

Sample Input XML

<cuicOperationRequest>
<operationType>POWER_CYCLE_SERVER</operationType>
<payload>
<![CDATA[
<PowerCycleServer>
<serverIdKey></serverIdKey>

</PowerCycleServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress }

See Also

Hard Reset Server

Power On Server

Power Off Server

Shutdown Server

Set Label on Server

Toggle Locator LED on Server

Power Off Server

Objective

Power Off one or more Servers.

Prerequisites

One or more Servers must be configured as Rack Accounts

REST URL

/cloupia/api-v2/PowerOffAction

Components

The parameters of the POWER_OFF_SERVER API are:

- String serverIdKey—The server Id key.

Sample Input XML

<cuicOperationRequest>
<operationType>POWER_OFF_SERVER</operationType>
<payload>
<![CDATA[
<PowerOffServer>
<serverIdKey></serverIdKey>

</PowerOffServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress

See Also

Power Cycle Server

Power On Server

Hard Reset Server

Shutdown Server

Set Label on Server

Toggle Locator LED on Server

Power On Server

Objective

Power On server.

Context

Power On one or more servers.

Prerequisites

One or more servers must be configured as rack accounts.

REST URL

/cloupia/api-v2/PowerOffAction

Components

The parameters of the POWER_ON_SERVER API are:

- String serverIdKey—The server Id key.

Sample Input XML

<cuicOperationRequest>
<operationType>POWER_ON_SERVER</operationType>
<payload>
<![CDATA[
<PowerOnServer>
<serverIdKey></serverIdKey>

</PowerOnServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.

See Also

Power Cycle Server

Hard Reset Server

Power Off Server

Shutdown Server

Set Label on Server

Toggle Locator LED on Server

Shutdown Server

Objective

Shut down one or more servers.

Prerequisites

One or more Servers must be configured as Rack Accounts.

REST URL

/cloupia/api-v2/ShutDownAction

Components

The parameters of the SHUT_DOWN_SERVER API are:

- String serverIdKey—The server Id key.

Sample Input XML

<cuicOperationRequest>
<operationType>SHUT_DOWN_SERVER</operationType>
<payload>
<![CDATA[
<ShutDownServer>
<serverIdKey></serverIdKey>

</ShutDownServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.

See Also

Power Cycle Server

Power On Server

Power Off Server

Hard Reset Server

Set Label on Server

Toggle Locator LED on Server

Set Label on Server

Objective

Set label for one or more servers.

Prerequisites

One or more Servers must be configured as Rack Accounts.

REST URL

/cloupia/api-v2/SetLabelAction

Components

The parameters of the SET_LABEL API are:

- String serverIdKey—The server Id key.

- String setLabel—The label name.

Sample Input XML

<cuicOperationRequest>
<operationType>SET_LABEL</operationType>
<payload>
<![CDATA[
<SetLabelServer>
<serverIdKey></serverIdKey>

<setLabel></setLabel>

</SetLabelServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.

See Also

Power Cycle Server

Power On Server

Power Off Server

Shutdown Server

Hard Reset Server

Toggle Locator LED on Server

Toggle Locator LED on Server

Objective

Toggle Locator LED one or more Servers.

Prerequisites

One or more Servers must be configured as Rack Accounts.

REST URL

/cloupia/api-v2/LocatorLedAction

Components

The parameters of the LOCATOR_LED API are:

- String serverIdKey—The server Id key.

- String locatorLed—The locator LED.

Sample Input XML

<cuicOperationRequest>
<operationType>LOCATOR_LED</operationType>
<payload>
<![CDATA[
<LocatorLedServer>
<serverIdKey></serverIdKey>

<locatorLed>ON</locatorLed>

</LocatorLedServer>

]]>
</payload>
</cuicOperationRequest>

Implementation

The serverIdKey must consist of a comma-separated list of Id's. Each Id is of the format: {AccountName};{ServerIPAddress}.

See Also

Power Cycle Server

Power On Server

Power Off Server

Shutdown Server

Set Label on Server

Hard Reset Server

Reading Servers by Tag Name

Objective

Get servers which are tagged with a specific name.

Prerequisites

One or more servers must be configured as Rack Accounts and be tagged.

REST URL

/cloupia/api-v2/ServersByTagName/{ServersByTagNameId}

Implementation

The ServersByTagValueId argument must be a valid tag value defined in the Tag Library.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Product ID

Reading Servers by Tag Value

Objective

Get Servers which are tagged with a specific value.

Prerequisites

One or more servers must be configured as Rack Accounts and be tagged.

REST URL

/cloupia/api-v2/ServersByTagValue/{ServersByTagValueId}

Implementation

The ServersByTagValueId argument must be a valid tag value defined in the Tag Library.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Product ID

Reading Servers by UUID

Reading Servers by Tag Name

Reading Server Faults by DN

Objective

Get Server Faults by affected DN.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsByDN/{CIMCFaultsByDNId}

Implementation

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.

See Also

Reading Server Faults by Account Name

Reading Server Faults by Fault Code

Reading Server Faults by IP Address

Reading Server Faults by Severity

Reading Server Faults by IP Address

Objective

Get Faults of a specific server by its IP address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsByServerIP/{CIMCFaultsByServerIPId}

Implementation

The CIMCFaultsByServerIPId argument must be a valid IP Address. The dots in the IP address need to be substituted with an underscore.

See Also

Reading Server Faults by Account Name

Reading Server Faults by Fault Code

Reading Server Faults by Account Name

Reading Server Faults by Severity

Reading Server Faults by Account Name

Objective

Get Faults of a specific server by its Account Name.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsByAccountName/{CIMCFaultsByAccountNameId}

Implementation

The CIMCFaultsByAccountNameId argument must be a valid Account Name of a server being managed by IMCS.

See Also

Reading Server Faults by DN

Reading Server Faults by Fault Code

Reading Server Faults by IP Address

Reading Server Faults by Severity

Reading Server Faults by Severity

Objective

Get Server Faults by Severity level.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsBySeverity/{CIMCFaultsBySeverityId}

Implementation

The CIMCFaultsBySeverityId argument must be a valid Severity Level.

See Also

Reading Server Faults by Account Name

Reading Server Faults by Fault Code

Reading Server Faults by IP Address

Reading Server Faults by Account Name

Reading Server Faults by Fault Code

Objective

Get Server Faults by Fault Code.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsByCode/{CIMCFaultsByCodeId}

Implementation

The CIMCFaultsByCodeId argument must be a valid Fault Code.

See Also

Reading Server Faults by DN

Reading Server Faults by Account Name

Reading Server Faults by IP Address

Reading Server Faults by Severity

Reading Server Faults History by DN

Objective

Get Server Faults by affected DN.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsHistoryByDN/{CIMCFaultsHistoryByDNId}

Implementation

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.

See Also

Reading Server Faults History by Fault Code

Reading Server Faults History by IP Address

Reading Server Faults History by Severity

Reading Server Faults History by Account Name

Reading Server Faults History by IP Address

Objective

Get Faults History of a specific server by its IP address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsHistoryByServerIP/{CIMCFaultsHistoryByServerIPId}

Implementation

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.

See Also

Reading Server Faults History by Fault Code

Reading Server Faults History by Account Name

Reading Server Faults History by Severity

Reading Server Faults History by DN

Reading Server Faults History by Account Name

Objective

Get Faults History of a specific server by its Account Name.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsHistoryByAccountName/{CIMCFaultsHistoryByAccountNameId}

Implementation

The CIMCFaultsHistoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.

See Also

Reading Server Faults History by Fault Code

Reading Server Faults History by IP Address

Reading Server Faults History by Severity

Reading Server Faults History by DN

Reading Server Faults History by Severity

Objective

Get Server Faults History by Severity level.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsHistoryBySeverity/{CIMCFaultsHistoryBySeverityId}

Implementation

The CIMCFaultsHistoryBySeverityId argument must be a valid Severity Level.

See Also

Reading Server Faults History by Fault Code

Reading Server Faults History by IP Address

Reading Server Faults History by Account Name

Reading Server Faults History by DN

Reading Server Faults History by Fault Code

Objective

Get Server Faults History by Fault Code.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCFaultsHistoryByCode/{CIMCFaultsHistoryByCodeId}

Implementation

The CIMCFaultsHistoryByCodeId argument must be a valid Fault Code.

See Also

Reading Server Faults History by Account Name

Reading Server Faults History by IP Address

Reading Server Faults History by Severity

Reading Server Faults History by DN

Reading Servers by Product ID

Objective

Get Server By Product ID.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerByProductID/{CIMCServerByProductIDId}

Implementation

The CIMCServerByProductIDId argument must be a valid Product ID of a server being managed by Cisco IMC Supervisor.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Tag Name

Reading Servers by Account Name

Objective

Get Servers By Account Name

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerByAccountName/{CIMCServerByAccountNameId}

Implementation

The CIMCServerByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.

See Also

Reading Servers by Product ID

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Tag Name

Reading Servers by UUID

Objective

Get Server By UUID

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerByUUID/{CIMCServerByUUIDId}

Implementation

The CIMCServerByUUIDId argument must be a valid UUID of a server being managed by Cisco IMC Supervisor.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by Product ID

Reading Servers by Tag Name

Reading Servers by Server IP

Objective

Get Server By IP Address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerByServerIP/{CIMCServerByServerIPId}

Implementation

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.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Serial Number

Reading Servers by Product ID

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Tag Name

Reading Servers by Serial Number

Objective

Get Server By Serial Number.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerBySerialNum/{CIMCServerBySerialNumId}

Implementation

The CIMCServerBySerialNumId argument must be a valid serial number of a server being managed by Cisco IMC Supervisor.

See Also

Reading Servers by Account Name

Reading Servers by Rack Group

Reading Servers by Product ID

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Tag Name

Reading Servers by Rack Group

Objective

Get Server By Rack Group.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerByRackGroup/{CIMCServerByRackGroupId}

Implementation

The CIMCServerByRackGroupId argument must be a valid Rack Group existing in Cisco IMC Supervisor.

See Also

Reading Servers by Account Name

Reading Servers by Product ID

Reading Servers by Serial Number

Reading Servers by Server IP

Reading Servers by Tag Value

Reading Servers by UUID

Reading Servers by Tag Name

Reading Server Inventory by Account Name

Objective

Get Server Inventory By Account Name.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerInventoryByAccountName/{CIMCServerInventoryByAccountNameId}

Implementation

The CIMCServerInventoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.

See Also

Reading Server Inventory by Server IP

Reading Server Inventory by Server IP

Objective

Get server inventory by IP address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerInventoryByServerIP/{CIMCServerInventoryByServerIPId}

Implementation

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.

See Also

Reading Server Inventory by Account Name

Reading Server Utilization by Account Name

Objective

Get Server Utilization By Account Name

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerUtilizationByAccountName/{CIMCServerUtilizationByAccountNameId}

Implementation

The CIMCServerUtilizationByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.

See Also

Reading Server Utilization by Server IP

Reading Server Utilization by Server IP

Objective

Get Server Utilization By IP Address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerUtilizationByServerIP/{CIMCServerUtilizationByServerIPId}

Implementation

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.

See Also

Reading Server Utilization by Account Name

Reading Server Utilization History by Account Name

Objective

Get Server Utilization History By Account Name.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerUtilizationHistoryByAccountName/{CIMCServerUtilizationHistoryByAccountNameId}

Implementation

The CIMCServerUtilizationHistoryByAccountNameId argument must be a valid Account Name of a server being managed by Cisco IMC Supervisor.

See Also

Reading Server Utilization History by Server IP

Reading Server Utilization History by Server IP

Objective

Get Server Utilization History By IP Address.

Prerequisites

None

REST URL

/cloupia/api-v2/CIMCServerUtilizationHistoryByServerIP/{CIMCServerUtilizationHistoryByServerIPId}

Implementation

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.

See Also

Reading Server Utilization History by Account Name

Overview

The examples in this category consists of managing users and user groups to access Cisco IMC Supervisor.

Disabling All Users in a Group

Objective

This task allows a user to disable all users which are assigned to a Group.

Prerequisites

None

REST URL

/cloupia/api-v2/group

Components

The parameter of the DISABLE_ALL_USERS_IN_GROUP API is:

String groupName—The name of the group or the customer organization.

Sample Input XML

<cuicOperationRequest>
<operationType>DISABLE_ALL_USERS_IN_GROUP</operationType>
<payload>
<![CDATA[
<DisableAllUsersInGroupConfig>
<groupID></groupID>

</DisableAllUsersInGroupConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

The groupId tag is mandatory and must include the numeric ID of a valid existing group.

See Also

Creating a Group

Modifying a Group

Deleting a Group

r_enable_all_users_group_d141.html

Creating a User

Objective

This task allows the user to create a new user.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameters of the CREATE API are:

- String userType—The type of user.

- String userGroup—Optional. The group of the user.

- String mspOrganization—Optional. MSP organization user.

- String loginName—The login name for the user.

- String password—The password for the user.

- String confirmPassword—Repeat the password from the previous field.

- String userContactEmail—The email address.

- String firstName—Optional. The first name of the group owner.

- String lastName—Optional. The last name of the group owner.

- String phone—Optional. The phone number of the group owner.

- String address—Optional. The address of the group owner.

Sample Input XML

<cuicOperationRequest>
<payload>
<![CDATA[
<AddUserConfig>
<userType>GroupAdmin</userType>

<!-- Accepts value from the list: userGroupByType-->
<userGroup>1</userGroup>

<mspOrganization></mspOrganization>

<loginName></loginName>

<!-- Accepts value from the list: password-->
<password></password>

<!-- Accepts value from the list: password-->
<confirmPassword></confirmPassword>

<userContactEmail></userContactEmail>

<firstName></firstName>

<lastName></lastName>

<phone></phone>

<address></address>

</AddUserConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Reading a User

Objective

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.

Prerequisites

None

REST URL

/cloupia/api-v2/user/{userId}

Implementation

The userId argument must be a valid login name of a user. If no argument is specified, no results will be returned.

See Also

r_creating_a_user_d184.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Updating a User

Objective

This task allows to update an existing user.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameters of the UPDATE USER API are:

- String loginName—The login name for the user.

- String userType—The type of user.

- String userGroup—Optional. The group of the user.

- String mspOrganization—Optional. MSP organization user.

- String userContactEmail—The email address.

- String firstName—Optional. The first name of the group owner.

- String lastName—Optional. The last name of the group owner.

- String phone—Optional. The phone number of the group owner.

- String address—Optional. The address of the group owner.

Sample Input XML

<cuicOperationRequest>
<operationType>UPDATE_USER</operationType>
<payload>
<![CDATA[
<ModifyUserConfig>
<loginName></loginName>

<userType>GroupAdmin</userType>

<userGroup>1</userGroup>

<mspOrganization></mspOrganization>

<userContactEmail></userContactEmail>

<firstName></firstName>

<lastName></lastName>

<phone></phone>

<address></address>

</ModifyUserConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Deleting a User

Objective

This task allows to delete an existing User.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameters of the DELETE_USER API are:

String loginName—The login name for the user.

Sample Input XML

<cuicOperationRequest>
<operationType>DELETE_USER</operationType>
<payload>
<![CDATA[
<DeleteUserConfig>
<loginName></loginName>

</DeleteUserConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Login Name is mandatory and must denote an existing valid user.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_enable_user_d188.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Enabling a User

Objective

This task allows to enable an existing user whose account has been disabled.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameter of the ENABLE_USER API is:

String loginName—The login name for the user.

Sample Input XML

<cuicOperationRequest>
<operationType>ENABLE_USER</operationType>
<payload>
<![CDATA[
<EnableUserConfig>
<loginName></loginName>

</EnableUserConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Login Name is mandatory and must denote an existing valid user.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Disabling a User

Objective

This task allows to disable an existing User whose account has been enabled.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameter of the DISABLE_USER API is:

String loginName—The login name for the user.

Sample Input XML

<cuicOperationRequest>
<operationType>DISABLE_USER</operationType>
<payload>
<![CDATA[
<DisableUserConfig>
<loginName></loginName>

</DisableUserConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

Login Name is mandatory and must denote an existing valid user.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_update_user_expiry_date_d190.html

r_updating_user_password_d191.html

Updating a User Expiry Date

Objective

This task allows to update the expiry date of an existing user.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The parameters of the DISABLE_DATE API are:

- String loginName—The login name for the user.

- Long userExpiryDate—The expiry date set for the user.

Sample Input XML

<cuicOperationRequest>
<operationType>DISABLE_DATE</operationType>
<payload>
<![CDATA[
<ConfigureUserExpiryDateConfig>
<loginName></loginName>

<!-- Accepts value from the list: date_time-->
<userExpiryDate>1460449200000</userExpiryDate>

</ConfigureUserExpiryDateConfig>

]]>
</payload>
</cuicOperationRequest>

Implementation

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.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_disable_user_d189.html

r_updating_user_password_d191.html

Updating a User Password

Objective

This task allows to update an existing user password.

Prerequisites

None

REST URL

/cloupia/api-v2/user

Components

The 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.

Sample Input XML

<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>

Implementation

Login Name is mandatory and must denote an existing valid User. Password and Confirm Password are mandatory and values must match.

See Also

r_creating_a_user_d184.html

r_reading_user_d185.html

r_modifying_a_user_d186.html

r_deleting_a_user_d187.html

r_enable_user_d188.html

r_disable_user_d189.html

r_update_user_expiry_date_d190.html

Preface

This preface contains the following sections:

- Audience

- Conventions

- Documentation Feedback

- Obtaining Documentation and Submitting a Service Request

- Related Documentation

Audience

This guide is intended primarily for data center administrators who use Cisco IMC Supervisor and who have responsibilities and expertise in server administration.

Conventions

Text Type

Indication

GUI elements

GUI elements such as tab titles, area names, and field labels appear in this font.

Main titles such as window, dialog box, and wizard titles appear in this font.

Document titles

Document titles appear in this font.

TUI elements

In a Text-based User Interface, text the system displays appears in this font.

System output

Terminal sessions and information that the system displays appear in this font.

CLI commands

CLI command keywords appear in this font.

Variables in a CLI command appear in this font.

[ ]

Elements in square brackets are optional.

{x | y | z}

Required alternative keywords are grouped in braces and separated by vertical bars.

[x | y | z]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

< >

Nonprinting characters such as passwords are in angle brackets.

[ ]

Default responses to system prompts are in square brackets.

!, #

An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

Note

Means reader take note. Notes contain helpful suggestions or references to material not covered in the document.

Caution

Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

Tip

Means the following information will help you solve a problem. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver.

Timesaver

Means the described action saves time. You can save time by performing the action described in the paragraph.

Warning

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device.

SAVE THESE INSTRUCTIONS

Documentation Feedback

To provide technical feedback on this document, or to report an error or omission, please send your comments to ucs-director-docfeedback@cisco.com. We appreciate your feedback.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation.

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.

Related Documentation

Cisco IMC Supervisor Documentation Set

Following are the documents that are available for Cisco IMC Supervisor:

- Cisco IMC Supervisor Release Notes

- Cisco IMC Supervisor Installation and Upgrade on VMware Vsphere Guide

- Cisco IMC Supervisor Rack-Mount Servers Management Guide

- Cisco IMC Supervisor Shell Guide

- Cisco IMC Supervisor REST API Getting Started Guide

- Cisco IMC Supervisor REST API Cook Book

Other Documentation

For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap available at the following URL: Click Here .

Note

The Cisco UCS C-Series Servers Documentation Roadmap includes links to documentation for Cisco Integrated Management Controller.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Click Here . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)