bigip_provision – Manage BIG-IP module provisioning
bigip_provision – Manage BIG-IP module provisioning
New in version 2.4.
Synopsis
- Manage BIG-IP module provisioning. This module will only provision at the standard levels of Dedicated, Nominal, and Minimum.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
level string |
|
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 Use This parameter is not relevant to | |
memory string added in 2.9 |
Sets additional memory for management module. This is in addition to minimum allocated RAM of 1264MB. The accepted value range is Specifying Specifying Specifying Use | ||
module string / required |
|
The module to provision in BIG-IP.
| |
provider dictionary added in 2.5 |
A dict object containing connection details. | ||
auth_provider string |
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile path |
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 | ||
timeout integer |
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. | ||
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / 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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
state string |
|
The state of the provisioned module on the system. When When
|
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- 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 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.
Examples
- name: Provision PEM at "nominal" level
bigip_provision:
module: pem
level: nominal
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Provision a dedicated SWG. This will unprovision every other module
bigip_provision:
module: swg
level: dedicated
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Provision mgmt with medium amount of memory.
bigip_provision:
module: mgmt
memory: medium
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
Return Values
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 |
memory string |
changed |
The new provisioned amount of memory for mgmt module.
Sample: large |
Status
- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
- Greg Crosby (@crosbygw)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_provision_module.html