Configure Tags on Cisco Intersight Resources

Introduction

This document describes the steps required to add tags to Cisco Intersight resources.

Background Information

A tag is a generic piece of key/value metadata which can be applied to resources within CIsco Intersight. These resources can vary from Server endpoints, to Accounts, and more.

As a user, tags can be used to group CIsco Intersight resources which will allow for querying of resources based on these tag values.

Within Cisco, there are various programs that rely on Cisco Intersight resource tags to enable/disable specific featuresets. Please refer to the documentation of the specific program for more information on those features and functionality.

Account Resource Tags

Requirements

• Account Administrator role for the account to be modified
• Access to the iam.Account API endpoint

When logged in via the UI, click the profile menu in the top right of the UI to show the logged-in Account and Role.

via the UI

1. Click the Services Selector
2. Select "System"

3. From the Settings > Account Details view, Click "Configure".

4. From the "Configure Account Settings" popup,a key:value pair can be submitted to add a new tag.

5. Once entered, click "Configure" to submit

 The tag must be entered with a in "key:value" format. For example above we entered:

AutoRMAEmail:kmccabe2@cisco.com,sttardy@cisco.com

This will create a tag on the Account resource with a key of AutoRMAEmail and a value of kmccabe2@cisco.com,sttardy@cisco.com.

Note: When adding a net-new tag, the auto-helper prediction will not show any options. Enter the net-new tag exactly as documented, then hit enter to submit.

6. Configured Tags can be validated form the Account Details view

Via the API

1. HTTP GET the iam.Account resource to find the Moid of the specific Account resource (AccountMoid) to be updated. Any existing Tags to be kept should be documented.

GET /api/v1/iam/Accounts

RESPONSE:
{
  "ObjectType": "iam.Account.List",
  "Results": [
    {
      "AccountMoid": "5eb2e1e47564612d307xxxxx",
      "Moid": "5eb2e1e47564612d307xxxxx",
      ...snip...
      "Tags": [{
        "Key":"existingKey",
        "Value":"existingVal"
      }]
    }]
}

2. HTTP POST the specific iam.Account resource by Moid and include the new and existing Tags in the request payload.

Note: If the Account Resource has existing Tags, they must be included in the POST to be retained. If they are not included in the POST, they will be deleted from the Account Resource.

POST /api/v1/iam/Accounts/5eb2e1e47564612d307xxxxx

PAYLOAD:
{
    "Tags": [{
        "Key": "existingKey",
        "Value": "existingVal"
    }, { 
        "Key": "ACIProactive", 
        "Value": "brvarney@cisco.com"
     }]
}

Infrastructure Service Resource Tags

via the UI List View

Resources that are displayed within a list view via the Infrastructure Service can be tagged. For Example, Servers, Clusters, Fabric Interconnects, Chassis, etc.

Note: Proactive RMA does not support any features enabled via Infrastrcture Service resource Tags. Do not use the below steps to configure Proactive RMA tags.

1. Within a list view, check the box of the resources to be tagged

2. Press the tag button located next to the ellipsis

3. Within the "Set Shared Tags" popup, enter the key:value tag to be applied to all selected objects

4. Hit "Save" to submit

Note: When adding a net-new tag, the auto-helper prediction will not show any options. Enter the net-new tag exactly as documented, then hit enter to submit.

Organization Resource Tags

Via API

1. Open API Docs for Organizations

Navigate to the api doc page for Organizations.

Note: If using the Connected Virtual Appliance, navigate to https://[FQDN  of appliance]/apidocs/apirefs/organization/Organizations/model/ instead

2. Identify Organization you wish to update.

Please see the Intersight API Query Guide for reference.

Users can simply use the GET endpoint to list all Organizations with no parameters. If there are too many organizations in your account to easily view in one output, users can use a $select query parameter to limit the fields shown, but ensure to inlcude Tags in the $select statement eg:

From the API output the field we need is the Moid field, this is a unique identifier for this organization in intersight and will be used in the next step, we also need to get any tags that are in there for the next step.

3. Update the Organization's Tags with the Organization PATCH API endpoint against the Organizations Moid. Ensure you re-enter existing tags gathered in the body field, or else they will be removed.

The body for the sample PATCH call above:

{"Tags":[{"Key":"AutoRMAEmail","Value":"joe@somedomain.com"}]}

Any existing tags that are on the registered can be added into the array of tags.

Please note: if you are following this procedure for to configure Proactive RMA, the email address(s) in here need to be correlative to a CCO Account.

Device Registration Resource Tags

Via the API

1. Open API Docs for Registered Devices

Navigate to the API doc page for Registered Devices

If using the Connected Virtual Appliance, navigate to https://[FQDN  of appliance]/apidocs/apirefs/asset/DeviceRegistrations/model/ instead

2. Identify the Registered Device which needs to be updated

Please see the Intersight API Query Guide for reference

One of the easiest ways to query is by hostname, to do this, a query could be crafted like:

DeviceHostname eq 'F340-21-22-UCS4'

Leveraging $filter and $select we see a more manageable output:

3. Use the PATCH API to update tags

Extract any tags that are alredy on the registerded device as well as the moid of the device. Nagivate to the PATCH endpoint, paste in the Moid in the top moid entry  For example:

The body for the sample PATCH call above:

{"Tags":[{"Key":"AutoRMAEmail","Value":"joe@somedomain.com"}]}

Any existing tags that are on the registered can be added into the array of tags.

Please note: if you are following this procedure for to configure Proactive RMA, the email address(s) in here need to be registered with a valid Cisco Account Username/CCO ID.