Adds doc fragments for the available env vars (#21251)

For F5 modules, the options that are commonly specified can
also be specified in the environment variables. This patch
adds the doc fragments that describe which env var goes
with which module option.
This commit is contained in:
Tim Rupp 2017-02-10 10:57:16 -08:00 committed by John R Barker
commit cbfe15a315

View file

@ -23,26 +23,33 @@ 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.
This option can be omitted if the environment variable C(F5_PASSWORD)
is set.
required: true required: true
server: server:
description: description:
- The BIG-IP host. - The BIG-IP host. This option can be omitted if the environment
variable C(F5_SERVER) is set.
required: true required: true
server_port: server_port:
description: description:
- The BIG-IP server port. - The BIG-IP server port. This option can be omitted if the environment
variable C(F5_SERVER_PORT) is set.
required: false required: false
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. administrative privileges on the device. This option can be omitted
if the environment variable C(F5_USER) is set.
required: true required: true
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be - If C(no), SSL certificates will not be validated. This should only be
used on personally controlled sites using self-signed certificates. used on personally controlled sites using self-signed certificates.
This option can be omitted if the environment variable
C(F5_VALIDATE_CERTS) is set.
required: false required: false
default: yes default: yes
choices: choices: