Updates documentation formatting and dependencies (#45252)
The documentation formatting was a bit incorrect and the dependencies
mentioned were out of date. This fixes that.
(cherry picked from commit 4154cab278
)
This commit is contained in:
parent
37d977c3b8
commit
264c7c22fb
1 changed files with 31 additions and 30 deletions
|
@ -23,72 +23,70 @@ options:
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- The password for the user account used to connect to the BIG-IP.
|
- The password for the user account used to connect to the BIG-IP.
|
||||||
You can omit this option if the environment variable C(F5_PASSWORD)
|
- You may omit this option by setting the environment variable C(F5_PASSWORD).
|
||||||
is set.
|
|
||||||
required: true
|
required: true
|
||||||
aliases: ['pass', 'pwd']
|
aliases: ['pass', 'pwd']
|
||||||
server:
|
server:
|
||||||
description:
|
description:
|
||||||
- The BIG-IP host. You can omit this option if the environment
|
- The BIG-IP host.
|
||||||
variable C(F5_SERVER) is set.
|
- You may omit this option by setting the environment variable C(F5_SERVER).
|
||||||
required: true
|
required: true
|
||||||
server_port:
|
server_port:
|
||||||
description:
|
description:
|
||||||
- The BIG-IP server port. You can omit this option if the environment
|
- The BIG-IP server port.
|
||||||
variable C(F5_SERVER_PORT) is set.
|
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
|
||||||
default: 443
|
default: 443
|
||||||
version_added: 2.2
|
version_added: 2.2
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
- The username to connect to the BIG-IP with. This user must have
|
- The username to connect to the BIG-IP with. This user must have
|
||||||
administrative privileges on the device. You can omit this option
|
administrative privileges on the device.
|
||||||
if the environment variable C(F5_USER) is set.
|
- You may omit this option by setting the environment variable C(F5_USER).
|
||||||
required: true
|
required: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. Use this only
|
- If C(no), SSL certificates are not validated. Use this only
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
You can omit this option if the environment variable
|
- You may omit this option by setting the environment variable
|
||||||
C(F5_VALIDATE_CERTS) is set.
|
C(F5_VALIDATE_CERTS).
|
||||||
|
default: yes
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
|
||||||
version_added: 2.0
|
version_added: 2.0
|
||||||
provider:
|
provider:
|
||||||
description:
|
description:
|
||||||
- A dict object containing connection details.
|
- A dict object containing connection details.
|
||||||
|
default: null
|
||||||
version_added: 2.5
|
version_added: 2.5
|
||||||
suboptions:
|
suboptions:
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- The password for the user account used to connect to the BIG-IP.
|
- The password for the user account used to connect to the BIG-IP.
|
||||||
You can omit this option if the environment variable C(F5_PASSWORD)
|
- You may omit this option by setting the environment variable C(F5_PASSWORD).
|
||||||
is set.
|
|
||||||
required: true
|
required: true
|
||||||
aliases: ['pass', 'pwd']
|
aliases: ['pass', 'pwd']
|
||||||
server:
|
server:
|
||||||
description:
|
description:
|
||||||
- The BIG-IP host. You can omit this option if the environment
|
- The BIG-IP host.
|
||||||
variable C(F5_SERVER) is set.
|
- You may omit this option by setting the environment variable C(F5_SERVER).
|
||||||
required: true
|
required: true
|
||||||
server_port:
|
server_port:
|
||||||
description:
|
description:
|
||||||
- The BIG-IP server port. You can omit this option if the environment
|
- The BIG-IP server port.
|
||||||
variable C(F5_SERVER_PORT) is set.
|
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
|
||||||
default: 443
|
default: 443
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
- The username to connect to the BIG-IP with. This user must have
|
- The username to connect to the BIG-IP with. This user must have
|
||||||
administrative privileges on the device. You can omit this option
|
administrative privileges on the device.
|
||||||
if the environment variable C(F5_USER) is set.
|
- You may omit this option by setting the environment variable C(F5_USER).
|
||||||
required: true
|
required: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. Use this only
|
- If C(no), SSL certificates are not validated. Use this only
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
You can omit this option if the environment variable
|
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
|
||||||
C(F5_VALIDATE_CERTS) is set.
|
default: yes
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
- Specifies the timeout in seconds for communicating with the network device
|
- Specifies the timeout in seconds for communicating with the network device
|
||||||
|
@ -99,21 +97,24 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies the SSH keyfile to use to authenticate the connection to
|
- Specifies the SSH keyfile to use to authenticate the connection to
|
||||||
the remote device. This argument is only used for I(cli) transports.
|
the remote device. This argument is only used for I(cli) transports.
|
||||||
If the value is not specified in the task, the value of environment
|
- You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
|
||||||
variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
|
||||||
transport:
|
transport:
|
||||||
description:
|
description:
|
||||||
- Configures the transport connection to use when connecting to the
|
- Configures the transport connection to use when connecting to the
|
||||||
remote device.
|
remote device.
|
||||||
required: true
|
required: true
|
||||||
choices:
|
choices:
|
||||||
- rest
|
- rest
|
||||||
- cli
|
- cli
|
||||||
default: cli
|
default: cli
|
||||||
|
|
||||||
notes:
|
notes:
|
||||||
- For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5).
|
- For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5).
|
||||||
- Requires the f5-sdk Python package on the host. This is as easy as C(pip install f5-sdk).
|
- Requires the f5-sdk Python package on the host. This is as easy as C(pip install f5-sdk).
|
||||||
|
- Requires BIG-IP software version >= 12.
|
||||||
|
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP
|
||||||
|
specific configuration persists to disk, be sure to include at least one task that uses the
|
||||||
|
M(bigip_config) module to save the running configuration. Refer to the module's documentation for
|
||||||
|
the correct usage of the module to save your running configuration.
|
||||||
requirements:
|
requirements:
|
||||||
- f5-sdk >= 3.0.9
|
- f5-sdk >= 3.0.16
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue