VM Naming and IPAM Strategies

Workload Manager lets you define a VM naming strategy and an IP address management (IPAM) strategy on a per cloud region basis. The VM naming strategy lets Workload Manager generate unique names for each of your VMs as they are launched. The IPAM strategy lets Workload Manager generate IP addresses for each of the vNICs on each of your VMs. The VM naming strategy can reference a VM naming callout script, and the IPAM strategy requires that you specify an IP address allocation callout script and an IP address deallocation callout script. An IP address allocation callout script may work in conjunction with a 3rd party IPAM server in your cloud environment.

Like External Lifecycle Actions, the scripts or commands associated with a VM naming strategy or IPAM strategy are executed in a containerized script execution engine running in the CloudCenter Suite cluster, if you are not using Cloud Remote in your region. If you are using Cloud Remote, theses scripts or commands will execute in a containerized script execution engine running in Cloud Remote. 

To set up the VM naming and IPAM strategies for your region, scroll down to the Strategy section of the Regions or Details tab and follow these steps.

Click the Edit Strategy link in the upper right to display the Edit Strategy dialog box as shown in the figure below.


The dialog box can reveal a total of seven data entry fields as explained in the table below:

FieldUsage

Strategy Bundle

Zip file containing all of the scripts associated with your VM naming strategy and/ or IPAM strategy. Select source from the dropdown and add the path in the new field that appears to the right.

Instance Naming Strategy

Dropdown for selecting one of three naming strategies: Default, CliQr Macro Replacement, and Hostname Callout. If you select CliQr Macro Replacement, the Node Name Config field become visible and required. If you select Hostname Callout, the Custom VM Name field become visible and required. See the Instance Naming Strategy table below for details.

Node Name Config

Required if you selected "CliQr Macro Replacement" for the Instance Naming Strategy field. Content: text string consisting of a combination of characters and numbers with embedded macro variables (see table below). The macros get translated to text strings at run time.

The resulting VM name string must meet the following requirements for a job submission to succeed:

  • Only contain the following characters:

    • Lowercase a to z 

    • 0 to 9

    • Hyphen 

  • Start with an alpha character

  • Cannot end with a hyphen

Instance IPAM Strategy

Dropdown menu with two choices: No IPAM (default), and IPAM Callouts. If you select the latter, two additional fields are displayed and become required: IPAM Alloc Rule and IPAM Dealloc Rule. (See below).

Custom VM Name

Location of your custom VM naming script if you set the Instance Naming Strategy field to "Custom Callout". Location options include "Script from bundle" if you specified a zip file in the Strategy Bundle field. See Guidance for Callout Scripts for guidance on developing custom VM naming scripts.

IPAM Alloc Rule

Location of your custom IPAM address allocation script if you set the Instance IPAM Strategy field to "IPAM Callouts". Location options include "Script from bundle" if you specified a zip file in the Strategy Bundle field. See Guidance for Callout Scripts for guidance on developing custom IPAM callout scripts.

IPAM Dealloc Rule

Similar to the IPAM Alloc Rule above except this is where you specify the location of your custom IPAM address deallocation script. See Guidance for Callout Scripts for guidance on developing custom IPAM callout scripts.

Instance Naming Strategy Options:

OptionsDescription
Default

The default method provided by Cisco is the generation of a string consisting of A predefined token prefixed with cqjw-

CliQr Macro Replacement

Selecting this method causes the Node Name Config field to be displayed and to become a required field. See the fields table above for details.

Hostname Callout

Selecting this method causes the Custom VM Name field to be displayed and to become a required field. See the fields table above for details.


OOB macro variables for CliQr Macro Replacement:

MacroReturned Value
%os1%First character of OS type string in lower case
%os2%First two characters 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 string

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

Only macro whose value can be user-customized.

  • No labels
Terms & Conditions Privacy Statement Cookies Trademarks