f5networks.f5_bigip.bigiq_utility_license_assignment (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
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(no), specifies the address, or hostname, where the BIG-IQ can
      reach the remote device to register.
    - When C(managed) is C(yes), specifies the managed device, or device UUID, you want
      to register.
    - If C(managed) is C(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.
    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

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(no), 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(no), 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