Class: Ansible::Ruby::Modules::Bigip_device_trust

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

Overview

Manage the trust relationships between BIG-IPs. Devices, once peered, cannot be updated. If updating is needed, the peer must first be removed before it can be re-added to the trust.

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

#peer_hostname ⇒ String?

Returns The hostname that you want to associate with the device. This value will be used to easily distinguish this device in BIG-IP configuration.,When trusting a new device, if this parameter is not specified, the value of C(peer_server) will be used as a default.

Returns:

  • (String, nil) —

    The hostname that you want to associate with the device. This value will be used to easily distinguish this device in BIG-IP configuration.,When trusting a new device, if this parameter is not specified, the value of C(peer_server) will be used as a default.



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

attribute :peer_hostname

#peer_password ⇒ String?

Returns The password of the API username of the remote peer device that you are trusting. If this value is not specified, then the value of C(password), or the environment variable C(F5_PASSWORD) will be used.

Returns:

  • (String, nil) —

    The password of the API username of the remote peer device that you are trusting. If this value is not specified, then the value of C(password), or the environment variable C(F5_PASSWORD) will be used.



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

attribute :peer_password

#peer_server ⇒ String

Returns The peer address to connect to and trust for synchronizing configuration. This is typically the management address of the remote device, but may also be a Self IP.

Returns:

  • (String) —

    The peer address to connect to and trust for synchronizing configuration. This is typically the management address of the remote device, but may also be a Self IP.



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

attribute :peer_server

#peer_user ⇒ String?

Returns The API username of the remote peer device that you are trusting. Note that the CLI user cannot be used unless it too has an API account. If this value is not specified, then the value of C(user), or the environment variable C(F5_USER) will be used.

Returns:

  • (String, nil) —

    The API username of the remote peer device that you are trusting. Note that the CLI user cannot be used unless it too has an API account. If this value is not specified, then the value of C(user), or the environment variable C(F5_USER) will be used.



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

attribute :peer_user

#state ⇒ :absent, ...

Returns When C(present), ensures the specified devices are trusted.,When C(absent), removes the device trusts.

Returns:

  • (:absent, :present, nil) —

    When C(present), ensures the specified devices are trusted.,When C(absent), removes the device trusts.



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

attribute :state

#type ⇒ :peer, ...

Returns Specifies whether the device you are adding is a Peer or a Subordinate. The default is C(peer).,The difference between the two is a matter of mitigating risk of compromise.,A subordinate device cannot sign a certificate for another device.,In the case where the security of an authority device in a trust domain is compromised, the risk of compromise is minimized for any subordinate device.,Designating devices as subordinate devices is recommended for device groups with a large number of member devices, where the risk of compromise is high.

Returns:

  • (:peer, :subordinate, nil) —

    Specifies whether the device you are adding is a Peer or a Subordinate. The default is C(peer).,The difference between the two is a matter of mitigating risk of compromise.,A subordinate device cannot sign a certificate for another device.,In the case where the security of an authority device in a trust domain is compromised, the risk of compromise is minimized for any subordinate device.,Designating devices as subordinate devices is recommended for device groups with a large number of member devices, where the risk of compromise is high.



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

attribute :type