bigiq_as3_deploy – Manages AS3 declarations sent to BIG-IQ

New in version 1.0.0.

Synopsis

  • Manages AS3 declarations sent to BIG-IQ.

Parameters

Parameter Choices/Defaults Configuration Comments
bigip_device
string
The BIG-IP device on which to remove the declaration.
Parameter required when state is absent, it is otherwise ignored.
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.
state
string
    Choices:
  • present ←
  • absent
When state is present, ensures the declaration is exists.
When state is absent, ensures that the declaration is removed.
tenant
string
An AS3 tenant you wish to remove.
Parameter required when state is absent, it is otherwise ignored.
timeout
integer
Default:
300
The amount of time in seconds to wait for the AS3 async interface to complete its task.
The accepted value range is between 10 and 1800 seconds.

Notes

Note

  • Due to limitations of the AS3 package on BIG-IQ, 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.bigiq
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Declaration with 2 Tenants - AS3
      bigiq_as3_deploy:
        content: "{{ lookup('file', 'two_tenants.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
tenant
string
changed
The AS3 tenant to be managed.

Sample:
foobar1


Status

Authors

  • Wojciech Wypior (@wojtek0806)