Last updated on: 2024-04-01 03:24:20.
bigiq_do_deploy – Manages DO declarations sent to BIG-IQ¶
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. |
||
|
task_id
string
|
The ID of the async task as returned by the system in a previous module run.
Used to query the status of the task on the device, useful with longer running operations that require restarting services.
|
||
|
timeout
integer
|
Default: 300
|
The amount of time in seconds to wait for the DO async interface to complete its task.
The accepted value range is between
150 and 3600 seconds. |
Examples¶
- name: Start simple declaration task
bigip_do_deploy:
content: "{{ lookup('file', 'do_bigiq_declaration.json') }}"
register: task
- name: Check for simple declaration status
bigiq_do_deploy:
task_id: result.task_id
timeout: 1000
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
|
|
message
dictionary
|
changed |
Informative message of the task status.
Sample:
hash/dictionary of values
|
|
task_id
dictionary
|
changed |
The task ID returned by the system.
Sample:
hash/dictionary of values
|