CliQr is now part of Cisco Learn More About Cisco

VM (Node) Name Config

Overview

CloudCenter allows admins to rename a VM (node) name configuration using a macro. This feature is referred to as Node Name Config in the CCM UI and can only be configured on a per-CCO basis at the region level.

Icon

The VM name configuration macro cannot be configured at the tenant level – it can only be configured at the region level.

Instance Naming Strategy

Icon

If you make changes to the callouts or attributes for a Cloud Region, you must restart the CCO for the changes to take effect.

If you make changes to the macro replacements for a Cloud Region, you must re-register the CCO with the CCM for the changes to take effect.

You can configure a new field called Instance Naming Strategy to identify callouts using a standard strategy for the following clouds:

  • AWS
  • OpenStack
  • AzureRM
  • VMware (example displayed below)

 

You can use one of the following options:

OptionsDescriptionSupported Clouds
DefaultThe default value provided by Cisco. A pre-defined token prefixed with cqjw- (see Configure Cloud(s) > Configure an Azure Resource Manager cloud for an example).
  • VMware
  • AWS
  • OpenStack
  • Azure
CliQr Macro Replacement

Marcos specified in the Node Name Config field are set as the instance name. If you choose this strategy, you must also configure the Node Name Config field. Your must first define the macros before specifying them. See the Pre-Defined Macros for the Node Name Config Field section later in this page.

To configure the the Node Name Config field, access the CCM UI's Configure Cloud Settings page for specific clouds (see Configure Cloud(s) for additional context).

  • VMware
  • AWS
  • OpenStack
  • Azure
Hostname Callout
  • VMware
  • AWS
  • OpenStack
  • Azure
  • Google

CCM UI Configuration

You should have already configured a cloud (see  Configure Cloud(s)) and added a region (see Cloud Region Configuration) for that cloud. This example displays an OpenStack configuration.

Icon

You must restart the CCO for the Node Name Config macro to take effect.

To configure the VM name, follow this procedure.

  1. From the CCM UI, click Admin > Clouds > cloud name. On the right, a list of regions configured for this cloud are displayed.
  2. Click Configure Region for the required cloud region. The Cloud Region tab page displays.
  3. Click Edit Cloud Settings. The Configure Cloud Settings popup displays.
  4. Configure the Node Name Config: See the Supported Node Name Macros section below to configure this field.

     
  5. Configure other fields for your cloud (the fields may differ depending on the cloud). The above example displays the OpenStack settings.
  6. Click Save. The Cloud Configuration page refreshes to update the cloud settings and provides a status message.
  7. Restart the CCO for the Node Name Config macro to take effect.

Instance IPAM Strategy

Icon

If you make changes to the callouts or attributes for a Cloud Region, you must restart the CCO for the changes to take effect.

Administrators can configure IPAM callouts at the cloud region level for VMware (example displayed below), AWS, and OpenStack clouds using one of two options:

OptionsDescription
No IPAMThis instance does not use IPAM callouts.
IPAM CalloutIf you select this option,
  • You must ensure that the IPAM callout is configured on the CCO (see Callout Scripts or InfoBlox for additional context).
  • The VMs will launch with IPs as configured by the IPAM callout.

VMware Customization Spec

VMware's  OS customization Spec feature allows you to configure network settings in vSphere (the VMware console). The CloudCenter platform allows you to specify the name of the Customization Spec (already created on the VMware vShpere console), in the IPAM callout script. To specify this spec, select IPAM Callout in the the Instance IPAM Strategy field.

If you set the VMware IPAM strategy as IPAM Callout, you have multiple options.

  • Use it to indicate the IPAM Callout in the table above and the CloudCenter platform completes the Static or Dynamic IP configuration.
  • Specify the Name of the Customization Spec in the Callout script.
    • If the CloudCenter platform detects the value in the custSpec key, then it ignores all other settings.
    • To specify the Name of the Customization Spec in the Callout script, ensure that the IPAM Callout script contains the following key-value pair :
      custSpec=CustSpec101

The IPAM Callout Script

See Callout Scripts for additional details.

Pre-defined Macros for the Node Name Config Field

The VM name should meet the following requirements for a job submission to succeed

  • Only contain the following characters:
    • a to z (lowercase only)  
    • 0 to 9
    •  The - (hyphen)
  • Start with an alphabet
  • Cannot end with - (hyphen)

The pre-defined macros that you can use for the CliQr Macro Replacement Option are listed in the following table:

NameValueNotes
%os1%First character of OS type string in lower case 
%os2%First two character of os type string in lower case 
%OS1%First character of os type string in upper case 
%OS2%First two character of os type string in upper case 
%RND<number>%Fixed length random string, e.g., %RND10%, 10 character long random stringThis is a mandatory field, only values in the range : %RND6% to %RND11% or just %RND% which defaults to %RND6%"
%UID%User ID 
%VID%Vendor ID 
%VM_PREFIX%VM name prefix must be added as a global parameter in the app profileOnly macro whose value can be user customized