Last updated on: 2024-04-01 03:24:20.
bigip_provision_async – Manage BIG-IP module provisioning¶
New in version 1.25.0.
Synopsis¶
- Manages BIG-IP module provisioning. This module will perform provisioning operations in an asynchronous way. See the Notes section for more information.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments | |
---|---|---|---|---|
check_status
boolean
|
|
If
true , then the module will run to check provisioning progress.Required parameter, if using the
module parameter. |
||
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
dedicated requires setting all others to none . Setting the level of a module to none means the module is not activated.Use a
state if absent to set c(level) to none and de-provision the module.This parameter is not relevant to
cgnat - pre tmos 15.0 or mgmt and will not be applied to the cgnat - pre tmos 15.0 or the mgmt module. |
||
memory
string
|
Sets additional memory for the management module. This is in addition to the minimum allocated RAM of 1264MB.
The accepted value range is
0 - 8192 . Maximum value is restricted by the available RAM in the system.Specifying
large reserves an additional 500MB for the mgmt module.Specifying
medium reserves an additional 200MB for the mgmt module.Specifying
small reserves no additional RAM for the mgmt module.Use
large for configurations containing more than 2000 objects, or more specifically, for any configuration that exceeds 1000 objects per 2 GB of installed memory. Changing the Management mgmt size after initial provisioning causes a re-provision operation. |
|||
module
string
/ required
|
|
The module to provision in BIG-IP.
aliases: name |
||
provider
dictionary
added in 1.0.0 |
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.
|
|||
no_f5_teem
boolean
|
|
If
yes , TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable
F5_TELEMETRY_OFF .Previously used variable
F5_TEEM is deprecated as its name was confusing. |
||
password
string
/ required
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
|||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
|||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
||
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 or the BIG-IQ. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
|||
validate_certs
boolean
|
|
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 . |
||
state
string
|
|
The state of the provisioned module on the system. If
present , then that guarantees the specified module is provisioned at the requested level, provided there are sufficient resources on the device (such as physical RAM) to support the module.If
absent , then that de-provisions the module.absent , is not an option for the mgmt module, as it cannot be de-provisioned. |
||
status_timeout
integer
|
Default: 300
|
The amount of time in seconds to wait for provisioning process to finish.
The accepted value range is between
150 and 3600 seconds.If the device needs to restart the module, then it will return with no change and an appropriate message. In such cases, you must pause the playbook execution, until the device is ready (see the
EXAMPLES section). |
Notes¶
Note
- Checking for provisioning status with the
check_status
parameter is not idempotent (see theEXAMPLES
section). - The module allows the same provisioning operations as bigip_provision with the difference being that it will not wait through the service restarts or device reboots. This is to fix the edge cases, when using this module in certain environments that can cause a timeout or be stuck in infinite loops, despite the provisioning operation being successful.
- Use the module in conjunction with the
bigip_wait
module, for best results. - This module requires TMOS version of 15.x and above.
- 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 f5networks.f5_modules.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 GTM on the device
bigip_provision_async:
module: "gtm"
provider:
server: lb.mydomain.com
password: secret
user: admin
- name: Check for provision progress
bigip_provision_async:
module: "gtm"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
register: status
- name: Wait for 3 minutes if device is restarting services
bigip_wait:
timeout: 180
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
when:
- result.message == "Device is restarting services, unable to check provisioning status."
- name: Re-check for provision progress
bigip_provision_async:
module: "gtm"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
register: status
when:
- status.message == "Device is restarting services, unable to check provisioning status."
- name: Provision GTM on the device - Idempotent Check
bigip_provision_async:
module: "gtm"
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
register: result
when:
- status.message == "Device has finished provisioning the requested module."
- name: Assert Provision GTM on the device - Idempotent Check
assert:
that:
- result is not changed
when:
- status.message == "Device has finished provisioning the requested module."
- name: Provision VCMP on the device
bigip_provision_async:
module: "vcmp"
level: "dedicated"
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
- name: Check for provision progress
bigip_provision_async:
module: "vcmp"
level: "dedicated"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
register: status
- name: Wait for 10 minutes if device is restarting services
bigip_wait:
timeout: 600
type: vcmp
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
when:
- result.message == "Device is restarting services, unable to check provisioning status."
- name: Re-check for provision progress
bigip_provision_async:
module: "vcmp"
level: "dedicated"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
delegate_to: localhost
register: status
when:
- status.message == "Device is restarting services, unable to check provisioning status."
- name: Provision VCMP on the device - Idempotent Check
bigip_provision_async:
module: "vcmp"
level: "dedicated"
provider:
server: lb.mydomain.com
password: secret
user: admin
register: result
delegate_to: localhost
when:
- status.message == "Device has finished provisioning the requested module."
- name: Assert Provision VCMP on the device - Idempotent Check
assert:
that:
- result is not changed
when:
- status.message == "Device has finished provisioning the requested module."
- name: De-provision VCMP on the device
bigip_provision_async:
module: "vcmp"
state: "absent"
provider:
server: lb.mydomain.com
password: secret
user: admin
- name: Check for de-provision progress
bigip_provision_async:
module: "vcmp"
state: "absent"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
register: status
- name: Wait for 10 minutes if device is restarting services
bigip_wait:
timeout: 600
provider:
server: lb.mydomain.com
password: secret
user: admin
when:
- result.message == "Device is restarting services, unable to check provisioning status."
- name: Re-check for de-provision progress
bigip_provision_async:
module: "vcmp"
state: "absent"
check_status: true
status_timeout: 900
provider:
server: lb.mydomain.com
password: secret
user: admin
register: status
when:
- status.message == "Device is restarting services, unable to check provisioning status."
- name: De-provision VCMP on the device - Idempotent Check
bigip_provision_async:
module: "vcmp"
state: "absent"
provider:
server: lb.mydomain.com
password: secret
user: admin
register: result
when:
- status.message == "Device has finished de-provisioning the requested module."
- name: Assert Provision VCMP on the device - Idempotent Check
assert:
that:
- result is not changed
when:
- status.message == "Device has finished de-provisioning the requested module."
Return Values¶
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 the mgmt module.
Sample:
large
|
message
dictionary
|
changed |
Informative message of the ansible task status.
Sample:
hash/dictionary of values
|