Parameter |
Choices/Defaults |
Comments |
peer_hostname
string
|
|
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 peer_server will be used as a default.
|
peer_password
string
|
|
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 password , or the environment variable F5_PASSWORD will be used.
|
peer_server
string
/ required
|
|
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.
|
peer_user
string
|
|
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 user , or the environment variable F5_USER will be used.
|
provider
dictionary
added in 2.5 |
|
A dict object containing connection details.
|
|
auth_provider
string
|
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|
password
string
/ required
|
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD .
aliases: pass, pwd
|
|
server
string
/ required
|
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
ssh_keyfile
path
|
|
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE .
|
|
timeout
integer
|
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
user
string
/ required
|
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER .
|
|
validate_certs
boolean
|
|
If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS .
|
state
string
|
Choices:
- absent
present ←
|
When present , ensures the specified devices are trusted.
When absent , removes the device trusts.
|
type
string
|
Choices:
peer ←
- subordinate
|
Specifies whether the device you are adding is a Peer or a Subordinate. The default is 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.
|