intersight_pool_reservation

Manage pool identifier reservations in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_pool_reservation

Synopsis

Manage pool identifier reservations in Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
pool_type	string	yes		The type of pool to manage reservations for. Choices: `ip`, `uuid`, `mac`, `wwnn`, `wwpn`
pool_name	string	yes		Name of the pool to reserve from.
organization	string		`default`	The name of the Organization the pool belongs to.
identity	string			The specific identifier value to reserve (e.g., an IP address, UUID, MAC address). Required when C(state) is C(present).
state	string		`present`	If C(present), will reserve the identifier in the pool. If C(absent), will release the reservation. Choices: `present`, `absent`
allocation_type	string		`static`	Whether the reservation is C(static) (specific value) or C(dynamic) (next available from pool). When C(static), C(identity) is required. When C(dynamic), the pool assigns the next available identifier. Choices: `static`, `dynamic`

Example

yaml

- cisco.intersight.intersight_pool_reservation:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    identity: 10.10.10.100
    pool_name: IP-Pool-01
    pool_type: ip
  name: Reserve a specific IP address from a pool

- cisco.intersight.intersight_pool_reservation:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    identity: 550e8400-e29b-41d4-a716-446655440000
    pool_name: UUID-Pool-01
    pool_type: uuid
  name: Reserve a specific UUID from a pool

- cisco.intersight.intersight_pool_reservation:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    identity: 00:25:B5:00:00:01
    pool_name: MAC-Pool-01
    pool_type: mac
  name: Reserve a MAC address

- cisco.intersight.intersight_pool_reservation:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    identity: 10.10.10.100
    pool_name: IP-Pool-01
    pool_type: ip
    state: absent
  name: Release a reservation

- cisco.intersight.intersight_pool_reservation:
    allocation_type: dynamic
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    pool_name: IP-Pool-01
    pool_type: ip
  name: Reserve next available IP (dynamic)