Last updated on: 2024-05-14 02:50:40.
bigiq_regkey_license_assignment – Manage regkey license assignment on BIG-IPs from a BIG-IQ¶
New in version 1.0.0.
Synopsis¶
- Manages the assignment of regkey 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.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
device
string
/ required
|
When
managed is false , specifies the address, or hostname, where the BIG-IQ can reach the remote device to register.When
managed is true , specifies the managed device, or device UUID, that you want to register.If
managed is 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. |
||
device_password
string
|
The password of the
device_username .When
managed is false , 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 is
443 . |
|
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 false , this parameter is required. |
||
key
string
/ required
|
The registration key you want to assign from the pool.
|
||
managed
boolean
|
|
Whether the specified device is a managed or un-managed device.
When
state is present , this parameter is required. |
|
pool
string
/ required
|
The registration key pool to use.
|
||
state
string
|
|
When
present , ensures the device is assigned the specified license.When
absent , ensures the license is revoked from the remote device and freed on the BIG-IQ. |
Examples¶
- name: Register an unmanaged device
bigiq_regkey_license_assignment:
pool: my-regkey-pool
key: XXXX-XXXX-XXXX-XXXX-XXXX
device: 1.1.1.1
managed: false
device_username: admin
device_password: secret
state: present
- name: Register a managed device, by name
bigiq_regkey_license_assignment:
pool: my-regkey-pool
key: XXXX-XXXX-XXXX-XXXX-XXXX
device: bigi1.foo.com
managed: true
state: present
- name: Register a managed device, by UUID
bigiq_regkey_license_assignment:
pool: my-regkey-pool
key: XXXX-XXXX-XXXX-XXXX-XXXX
device: 7141a063-7cf8-423f-9829-9d40599fa3e0
managed: true
state: present