cm_next_as3_deploy – Manages Deploying an AS3 declaration to a specified instance managed by BIG-IP Next Central Manager.¶
New in version 1.0.0.
Synopsis¶
- Manages Deploying an AS3 declaration to a specified instance managed by BIG-IP Next Central Manager.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
content
raw
/ required
|
The declaration to be configured on the system.
This parameter is most often used 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.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
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 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. |
||
state
string
|
|
When
state is present , ensures the declaration is exists.When
state is absent , ensures the declaration is removed. |
|
target_ip
string
/ required
|
The IP address of the BIG-IP Next instance on which to manage the AS3 declaration.
|
||
timeout
integer
|
Default: 300
|
The amount of time to wait for the AS3 interface to complete the deletion task, in seconds.
The accepted value range is between
10 and 1800 seconds. |
Examples¶
- name: Declaration with 2 Tenants - AS3
cm_next_as3_deploy:
content: "{{ lookup('file', 'two_tenants.json') }}"
target_ip: "1.2.3.4"
- name: Remove one tenant - AS3
cm_next_as3_deploy:
content: "{{ lookup('file', 'two_tenants.json') }}"
target_ip: "1.2.3.4"
state: absent
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
|
target_ip
string
|
changed |
The IP address of the BIG-IP Next instance on which to deploy the AS3 declaration.
Sample:
1.2.3.4
|