Class: Ansible::Ruby::Modules::Bigiq_utility_license_assignment

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#device ⇒ String?

Returns 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, that you want to register.,If C(managed) is C(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.

Returns:

  • (String, nil) —

    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, that you want to register.,If C(managed) is C(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.



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 24

attribute :device

#device_password ⇒ String?

Returns The password of the C(device_username).,When C(managed) is C(no), this parameter is required.

Returns:

  • (String, nil) —

    The password of the C(device_username).,When C(managed) is C(no), this parameter is required.



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 40

attribute :device_password

#device_port ⇒ Integer?

Returns Specifies the port of the remote device to connect to.,If this parameter is not specified, the default of C(443) will be used.

Returns:

  • (Integer, nil) —

    Specifies the port of the remote device to connect to.,If this parameter is not specified, the default of C(443) will be used.



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 32

attribute :device_port

#device_username ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 36

attribute :device_username

#key ⇒ String

Returns The registration key that you want choose an offering from.

Returns:

  • (String) —

    The registration key that you want choose an offering from.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 16

attribute :key

#managed ⇒ Symbol?

Returns Whether the specified device is a managed or un-managed device.,When C(state) is C(present), this parameter is required.

Returns:

  • (Symbol, nil) —

    Whether the specified device is a managed or un-managed device.,When C(state) is C(present), this parameter is required.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 28

attribute :managed

#offering ⇒ String?

Returns Name of the license offering to assign to the device.

Returns:

  • (String, nil) —

    Name of the license offering to assign to the device.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 20

attribute :offering

#state ⇒ :present, ...

Returns When C(present), ensures that 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.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that 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.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 44

attribute :state

#unit_of_measure ⇒ :hourly, ...

Returns 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.

Returns:

  • (:hourly, :daily, :monthly, :yearly, nil) —

    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.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigiq_utility_license_assignment.rb', line 12

attribute :unit_of_measure