New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
hostname |
yes |
Hostname of the BIG-IP host.
|
||
password |
yes |
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable
F5_PASSWORD is set. |
||
server |
yes |
The BIG-IP host. This option can be omitted if the environment variable
F5_SERVER is set. |
||
server_port (added in 2.2) |
no | 443 |
The BIG-IP server port. This option can be omitted if the environment variable
F5_SERVER_PORT is set. |
|
user |
yes |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable
F5_USER is set. |
||
validate_certs (added in 2.0) |
no | True |
|
If
no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set. |
- name: Set the hostname of the BIG-IP bigip_hostname: hostname: "bigip.localhost.localdomain" password: "admin" server: "bigip.localhost.localdomain" user: "admin" delegate_to: localhost
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
hostname |
The new hostname of the device
|
changed | string | big-ip01.internal |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.