cisco.intersight.intersight_uuid_pool module – UUID Pool configuration for Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.2.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.intersight.
To use it in a playbook, specify: cisco.intersight.intersight_uuid_pool.
Synopsis
UUID Pool configuration for Cisco Intersight.
Used to configure UUID pools settings on Cisco Intersight managed devices.
For more information see Cisco Intersight.
Parameters
Parameter |
Comments |
|---|---|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– <your private key data> —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
The user-defined description of the UUID Pool. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
The name assigned to the UUID Pool. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
The name of the Organization this resource is assigned to. Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization. Default: |
|
The UUID prefix used for all UUID suffix blocks. UUID must be in uppercase in order to support idempotency. The prefix must be in the format XXXXXXXX-XXXX-XXXX (8-4-4) where X is a hexadecimal character (0-9, A-F). This prefix will be combined with the suffix blocks to form complete UUIDs. Required for |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
If Choices:
|
|
List of UUID suffix blocks that define the range of UUIDs available in the pool. Each block defines a starting suffix and the number of consecutive UUIDs in that block. Required for |
|
The starting UUID suffix for this block. UUID must be in uppercase in order to support idempotency. The suffix must be in the format XXXX-XXXXXXXXXXXX (4-12) where X is a hexadecimal character (0-9, A-F). This suffix will be combined with the pool prefix to form complete UUIDs. |
|
The number of consecutive UUIDs in this block. Must be a positive integer representing how many UUIDs are available starting from the ‘from’ suffix. |
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- name: Configure UUID Pool
cisco.intersight.intersight_uuid_pool:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: DevNet
name: lab-uuid-pool
description: UUID Pool for lab use
prefix: "550E8400-E29B-41D4"
uuid_suffix_blocks:
- from: "A716-446655440000"
size: 100
- from: "A716-446655441000"
size: 200
tags:
- Key: Site
Value: RCDN
- name: Delete UUID Pool
cisco.intersight.intersight_uuid_pool:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: DevNet
name: lab-uuid-pool
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response output returned by the specified resource. Returned: always Sample: |