Cisco IMC Supervisor REST API Cookbook, Release 2.0

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

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

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

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

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

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

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

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

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

Reading Server Faults History by Severity

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.

Reading Server Faults History by Severity

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.

Reading Server Faults History by Severity

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.

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.

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

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

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

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

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

The parameters of the DELETE_USER API are:

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

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

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

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

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

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

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

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

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

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