Last updated on: 2024-04-01 03:24:20.
bigip_ts_deploy – Manages TS declarations sent to BIG-IP¶
New in version 1.0.0.
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. |
||
|
force
boolean
|
|
If
true, the declaration is uploaded regardless if there is a change or not, option is useful when changing declaration's cipherText key/pair.If
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 cipherText key/pair as the paraphrases returned by device are encrypted. |
|
|
state
string
|
|
When
state is present, ensures the declaration is exists.When
state is absent, ensures that the declaration is removed. |
Examples¶
- name: Declaration with 2 Tenants - AS3
bigip_ts_deploy:
content: "{{ lookup('file', 'ts_declaration.json') }}"
- name: Upload declaration - force yes
bigip_ts_deploy:
content: "{{ lookup('file', 'ts_declaration.json') }}"
force: true
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
|