Parameter |
Choices/Defaults |
Comments |
command
|
|
The command to alias.
|
description
|
|
Description of the alias.
|
name
required |
|
Specifies the name of the alias.
|
partition
|
Default:
Common
|
Device partition to manage resources on.
This parameter is disregarded when the scope is private .
|
password
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
|
provider
(added in 2.5) |
Default:
None
|
A dict object containing connection details.
|
|
password
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
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
user
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
bool |
|
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 .
|
|
timeout
|
Default:
10
|
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.
|
|
ssh_keyfile
|
|
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 .
|
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
scope
|
Choices:
- private
shared ←
|
The scope of the alias; whether it is shared on the system, or usable only for the user who created it.
|
server
required |
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
server_port
(added in 2.2) |
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
state
|
Choices:
present ←
- absent
|
When present , ensures that the resource exists.
When absent , ensures the resource is removed.
|
user
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
bool
(added in 2.0) |
|
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 .
|