bigiq_utility_license_assignment – Manage utility license assignment on BIG-IPs from a BIG-IQ¶
New in version 1.0.0.
Synopsis¶
- 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.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
device
string
/ required
|
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, you want to register.If
managed is yes , 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 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 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 no , this parameter is required. |
||
key
string
/ required
|
The registration key from which you want choose an offering.
|
||
managed
boolean
|
|
Whether the specified device is a managed or un-managed device.
When
state is present , this parameter is required. |
|
offering
string
/ required
|
Name of the license offering to assign to the device.
|
||
state
string
|
|
When
present , ensures 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
|
|
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.
|
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: false
device_username: admin
device_password: secret
state: present
- 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
- 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