- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigiq_utility_license_assignment – Manage utility license assignment on BIG-IPs from a BIG-IQ

New in version 2.7.

- Synopsis

- Parameters

- Notes

- Examples

- Status

## Synopsis

- Manages the assignment of utility licenses on a BIG-IQ. Assignment means that the license is assigned to a BIG-IP, or, it needs to be assigned to a BIG-IP. Additionally, this module supported revoking the assignments from BIG-IP devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
device string |  | When `managed` is `no`, specifies the address, or hostname, where the BIG-IQ can reach the remote device to register. When `managed` is `yes`, specifies the managed device, or device UUID, that you want to register. If `managed` is `yes`, it is very important that you do not have more than one device with the same name. BIG-IQ internally recognizes devices by their ID, and therefore, this module's cannot guarantee that the correct device will be registered. The device returned is the device that will be used.
device_password string |  | The password of the `device_username`. When `managed` is `no`, this parameter is required.
device_port integer | Default: 443 | Specifies the port of the remote device to connect to. If this parameter is not specified, the default of `443` will be used.
device_username string |  | 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 `Administrator` role. When `managed` is `no`, this parameter is required.
key string / required |  | The registration key that you want choose an offering from.
managed boolean | Choices: no yes | Whether the specified device is a managed or un-managed device. When `state` is `present`, this parameter is required.
offering string |  | Name of the license offering to assign to the device.
provider dictionary added in 2.5 |  | A dict object containing connection details.
| auth_provider string |  | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
| password string / required |  | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| timeout integer |  | 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.
| transport string | Choices: cli rest ← | Configures the transport connection to use when connecting to the remote device.
| user string / required |  | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
| validate_certs boolean | Choices: no yes ← | If `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 `F5_VALIDATE_CERTS`.
state string | Choices: present ← absent | When `present`, ensures that the device is assigned the specified license. When `absent`, ensures the license is revokes from the remote device and freed on the BIG-IQ.
unit_of_measure string | Choices: hourly ← daily monthly yearly | Sets the rate at which this license usage is billed. Depending on your license, you may have different units of measures available to you. If a particular unit is not available to you, the module will notify you at licensing time.

## Notes

Note

- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.

- Requires BIG-IP software version >= 12.

- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

## Examples

    - 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: no
        device_username: admin
        device_password: secret
        state: present
        provider:
          password: secret
          server: lb.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: yes
        state: present
        provider:
          password: secret
          server: lb.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: yes
        state: present
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.