f5networks.f5_bigip.bigip_ts_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 TS declarations sent to 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_ts_deploy:
    content: "{{ lookup('file', 'ts_declaration.json') }}"

Scanned by Steampunk Spotter

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

- name: Upload declaration - force yes
  bigip_ts_deploy:
    content: "{{ lookup('file', 'ts_declaration.json') }}"
    force: true

Inputs

    
force:
    default: false
    description:
    - If C(true), the declaration is uploaded regardless if there is a change or not,
      option is useful when changing declaration's C(cipherText) key/pair.
    - If C(false), the declaration is only uploaded if there is a difference to what is
      on the device. The comparison is not performed on declaration's C(cipherText) key/pair
      as the paraphrases returned by device are encrypted.
    type: bool

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 that the declaration is removed.
    type: str

content:
    description:
    - Declaration to be configured on the system.
    - This parameter is most often used along 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.
    - 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 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 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.
    type: raw

Outputs

content:
  description: The declaration sent to the system.
  returned: changed
  sample: hash/dictionary of values
  type: dict