New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
device | 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 | The password of the device_username .When managed is no , this parameter is required. | ||
device_port | 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 | 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 required | The registration key that you want choose an offering from. | ||
managed bool |
| Whether the specified device is a managed or un-managed device. When state is present , this parameter is required. | |
offering | Name of the license offering to assign to the device. | ||
password 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 | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
ssh_keyfile | 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 | Default: 10 | 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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
user 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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password 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 | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
state |
| 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 |
| 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. | |
user 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 bool (added in 2.0) |
| 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 . |
Note
pip install f5-sdk
.- 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigiq_utility_license_assignment_module.html