cisco.ucs.ucs_uuid_pool module – Configures server UUID pools on Cisco UCS Manager

Note

This module is part of the cisco.ucs collection (version 1.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ucs. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.ucs.ucs_uuid_pool.

Synopsis

  • Configures server UUID pools and UUID blocks on Cisco UCS Manager.

Requirements

The below requirements are needed on the host that executes this module.

  • ucsmsdk

Parameters

Parameter

Comments

description

aliases: descr

string

The user-defined description of the UUID pool.

Enter up to 256 characters.

You can use any characters or spaces except the following:

` (accent mark), (backslash), ^ (carat), ” (double quote), = (equal sign), > (greater than), < (less than), or ‘ (single quote).

first_uuid

string

The first UUID in the block of UUIDs.

This is the From field in the UCS Manager UUID Blocks menu.

hostname

string / required

IP address or hostname of Cisco UCS Manager.

Modules can be used with the UCS Platform Emulator https://cs.co/ucspe

last_uuid

string

The last UUID in the block of UUIDs.

This is the To field in the UCS Manager Add UUID Blocks menu.

name

string / required

The name of the UUID pool.

This name can be between 1 and 32 alphanumeric characters.

You cannot use spaces or any special characters other than - (hyphen), “_” (underscore), : (colon), and . (period).

You cannot change this name after the UUID pool is created.

order

string

The Assignment Order field.

This can be one of the following:

default - Cisco UCS Manager selects a random identity from the pool.

sequential - Cisco UCS Manager selects the lowest available identity from the pool.

Choices:

  • "default" ← (default)

  • "sequential"

org_dn

string

The distinguished name (dn) of the organization where the resource is assigned.

Default: "org-root"

password

string / required

Password for Cisco UCS Manager authentication.

port

integer

Port number to be used during connection (by default uses 443 for https and 80 for http connection).

prefix

string

UUID prefix used for the range of server UUIDs.

If no value is provided, the system derived prefix will be used (equivalent to selecting ‘derived’ option in UI).

If the user provides a value, the user provided prefix will be used (equivalent to selecting ‘other’ option in UI).

A user provided value should be in the format XXXXXXXX-XXXX-XXXX.

proxy

string

If use_proxy is no, specfies proxy to be used for connection. e.g. ‘http://proxy.xy.z:8080’

state

string

If present, will verify UUID pool is present and will create if needed.

If absent, will verify UUID pool is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

use_proxy

boolean

If no, will not use the proxy as defined by system environment variable.

Choices:

  • false

  • true ← (default)

use_ssl

boolean

If no, an HTTP connection will be used instead of the default HTTPS connection.

Choices:

  • false

  • true ← (default)

username

string

Username for Cisco UCS Manager authentication.

Default: "admin"

Examples

- name: Configure UUID address pool
  cisco.ucs.ucs_uuid_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: UUID-Pool
    order: sequential
    first_uuid: 0000-000000000001
    last_uuid: 0000-000000000078

- name: Remove UUID address pool
  cisco.ucs.ucs_uuid_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: UUID-Pool
    state: absent

Authors

  • David Soper (@dsoper2)

  • CiscoUcs (@CiscoUcs)