bigip_cfe_deploy – Manages CFE declarations sent to BIG-IP

New in version 1.0.0.

Synopsis

  • Manages CFE declarations sent to BIG-IP.

Parameters

Parameter Choices/Defaults Configuration Comments
content
raw
Declaration to be configured on the system.
This parameter is most often used along with the file or template lookup plugins. Refer to the examples section for correct usage.
For anything advanced or with formatting consider using the template lookup.
This can additionally be used for specifying application service configurations directly in YAML, however that is not an encouraged practice and, if used at all, should only be used for the absolute smallest of configurations to prevent your Playbooks from becoming too large.
If you content includes encrypted values (such as ciphertexts, passphrases, etc), the returned changed value will always be true.
If you are using the to_nice_json filter, it will cause this module to fail because the purpose of that filter is to format the JSON to be human-readable and this process includes inserting "extra characters that break JSON validators.

Notes

Note

  • Due to limitations of the CFE package, the module is not idempotent.

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: CFE Declaration
      bigip_cfe_deploy:
        content: "{{ lookup('file', 'cfe_declaration.json') }}"
        service_type: "as3"

Return Values

The following are the fields unique to this module:

Key Returned Description
content
dictionary
changed
The declaration sent to the system.

Sample:
hash/dictionary of values


Status

Authors

  • Wojciech Wypior (@wojtek0806)