f5networks / f5networks.f5_modules / 1.28.0 / module / bigiq_regkey_pool Manages registration key pools on BIG-IQ | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007)f5networks.f5_modules.bigiq_regkey_pool (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
Manages registration key (regkey) pools on a BIG-IQ. These pools function as a container in which you add lists of registration keys. To add registration keys, use the C(bigiq_regkey_license) module.
- name: Create a registration key (regkey) pool to hold individual device licenses bigiq_regkey_pool: name: foo-pool state: present provider: user: admin password: secret server: cm.mydomain.com delegate_to: localhost
name: description: - Specifies the name of the registration key pool. - You must name your registration pools unique names. While BIG-IQ does not require this, this module does. If you do not, the behavior of the module is undefined, and you may end up putting licenses in the wrong registration key pool. required: true type: str state: choices: - absent - present default: present description: - The state of the regkey pool on the system. - When C(present), guarantees the pool exists. - When C(absent), removes the pool, and the licenses it contains, from the system. type: str provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str no_f5_teem: default: false description: - If C(yes), TEEM telemetry data is not sent to F5. - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF). - Previously used variable C(F5_TEEM) is deprecated as its name was confusing. type: bool password: aliases: - pass - pwd description: - The password for the user account used to connect to the BIG-IP or the BIG-IQ. - You may omit this option by setting the environment variable C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. type: int transport: choices: - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. - You may omit this option by setting the environment variable C(F5_USER). required: true type: str validate_certs: default: true description: - If C(no), SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS). type: bool type: dict version_added: 1.0.0 version_added_collection: f5networks.f5_modules description: description: - A description to attach to the pool. type: str
description: description: New description of the regkey pool. returned: changed sample: My description type: str