bigip_provision – Manage BIG-IP module provisioning — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_provision – Manage BIG-IP module provisioning

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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 | Choices: dedicated nominal ← minimum | 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. Use `state` absent to set c(level) to none and de-provision 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 `mgmt` module.
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 `0 - 8192`. Maximum value is restricted by systems available RAM. Specifying `large` reserves an additional 500MB for mgmt module. Specifying `medium` reserves an additional 200MB for mgmt module. Specifying `small` reserves no additional RAM for 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 reprovision operation
module string / required | Choices: am afm apm asm avr cgnat fps gtm ilx lc ltm mgmt pem sam sslo swg urldb vcmp | The module to provision in BIG-IP. aliases: name
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 `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP 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`.
| 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 `ANSIBLE_NET_SSH_KEYFILE`.
| 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 | Choices: cli rest ← | 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 `F5_USER`.
| validate_certs boolean | Choices: no yes ← | 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 | Choices: present ← absent | 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. `absent`, is not a relevant option to `mgmt` module as module can not be de-provisioned.

## 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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.