f5networks.f5_bigip.bigip_as3_deploy (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

Manages AS3 declarations sent to the BIG-IP.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Declaration with 2 Tenants - AS3
  bigip_as3_deploy:
    content: "{{ lookup('file', 'two_tenants.json') }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Deploying Per-App Declaration
  bigip_as3_deploy:
    content: "{{ lookup('file', 'per-app-dec.json') }}"
    tenant: sample

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove one tenant - AS3
  bigip_as3_deploy:
    tenant: "Sample_01"
    state: absent

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(state) is C(present), ensures the declaration is exists.
    - When C(state) is C(absent), ensures the declaration is removed.
    type: str

tenant:
    description:
    - tenant is mandatory for Per-Application Deployment
    - An AS3 tenant you want to manage.
    - A value of C(all) when C(state) is C(absent) removes all AS3 declarations from the
      device.
    type: str

content:
    description:
    - The declaration to be configured on the system.
    - This parameter is most often used with the C(file) or C(template) lookup plugins.
      Refer to the examples section for correct usage.
    - For anything advanced or with formatting, consider using the C(template) lookup.
    - Additionally, this can 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 your C(content) includes encrypted values (such as ciphertexts, passphrases,
      etc), the returned C(changed) value will always be true.
    - If you are using the C(to_nice_json) filter, it causes 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.
    type: raw

timeout:
    default: 300
    description:
    - The amount of time to wait for the AS3 async interface to complete its task, in
      seconds.
    - The accepted value range is between C(10) and C(1800) seconds.
    type: int

Outputs

content:
  description: The declaration sent to the system.
  returned: changed
  sample: hash/dictionary of values
  type: dict
tenant:
  description: The AS3 tenant to be managed.
  returned: changed
  sample: foobar1
  type: str