f5networks / f5networks.f5_modules / 1.28.0 / module / bigiq_utility_license_assignment Manage utility license assignment on BIG-IPs from a BIG-IQ | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Tim Rupp (@caphrim007)f5networks.f5_modules.bigiq_utility_license_assignment (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 the assignment of utility licenses on a BIG-IQ. Assignment means the license is assigned to a BIG-IP, or it needs to be assigned to a BIG-IP. Additionally, this module supports revoking the assignments from BIG-IP devices.
- name: Register an unmanaged device bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: 1.1.1.1 managed: false device_username: admin device_password: secret state: present provider: password: secret server: cm.mydomain.com user: admin delegate_to: localhost
- name: Register a managed device, by name bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: bigi1.foo.com managed: true state: present provider: password: secret server: cm.mydomain.com user: admin delegate_to: localhost
- name: Register a managed device, by UUID bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: 7141a063-7cf8-423f-9829-9d40599fa3e0 managed: true state: present provider: password: secret server: cm.mydomain.com user: admin delegate_to: localhost
key: description: - The registration key from which you want choose an offering. required: true type: str state: choices: - present - absent default: present description: - When C(present), ensures the device is assigned the specified license. - When C(absent), ensures the license is revokes from the remote device and freed on the BIG-IQ. type: str device: description: - When C(managed) is C(false), specifies the address, or hostname, where the BIG-IQ can reach the remote device to register. - When C(managed) is C(true), specifies the managed device, or device UUID, you want to register. - If C(managed) is C(true), it is very important you do not have more than one device with the same name. BIG-IQ internally recognizes devices by their ID, and therefore, this module cannot guarantee the correct device will be registered. The device returned is the device that is used. required: true type: str managed: description: - Whether the specified device is a managed or un-managed device. - When C(state) is C(present), this parameter is required. type: bool offering: description: - Name of the license offering to assign to the device. required: true 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 device_port: default: 443 description: - Specifies the port of the remote device to connect to. - If this parameter is not specified, the default is C(443). type: int device_password: description: - The password of the C(device_username). - When C(managed) is C(false), this parameter is required. type: str device_username: description: - The username used to connect to the remote device. - This username should be one that has sufficient privileges on the remote device to do licensing. Usually this is the C(Administrator) role. - When C(managed) is C(false), this parameter is required. type: str unit_of_measure: choices: - hourly - daily - monthly - yearly default: hourly description: - Sets the rate at which this license usage is billed. - Depending on your license, you may have different units of measure available to you. If a particular unit is not available to you, the module notifies you at licensing time. type: str