New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
level |
| Sets the provisioning level for the requested modules. Changing the level for one module may require modifying the level of another module. For example, changing one module to dedicated requires setting all others to none . Setting the level of a module to none means that the module is not activated.This parameter is not relevant to cgnat and will not be applied to the cgnat module. | |
module required |
| The module to provision in BIG-IP. aliases: name | |
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. | |
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 . | ||
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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 | ||
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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
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 |
| The state of the provisioned module on the system. When present , guarantees that the specified module is provisioned at the requested level provided that there are sufficient resources on the device (such as physical RAM) to support the provisioned module. When absent , de-provision the module. | |
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 . |
Note
pip install f5-sdk
.- name: Provision PEM at "nominal" level bigip_provision: server: lb.mydomain.com module: pem level: nominal password: secret user: admin validate_certs: no delegate_to: localhost - name: Provision a dedicated SWG. This will unprovision every other module bigip_provision: server: lb.mydomain.com module: swg password: secret level: dedicated user: admin validate_certs: no delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
level string | changed | The new provisioning level of the module. Sample: minimum |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_provision_module.html