Last updated on: 2024-04-01 03:24:20.
velos_partition_wait – Wait for a VELOS chassis partition to match a condition before continuing¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
delay
integer
|
Default: 0
|
Number of seconds to wait before starting to poll.
|
|
|
msg
string
|
This overrides the normal error message from a failure to meet the required conditions.
|
||
|
name
string
/ required
|
Name of the chassis partition.
|
||
|
sleep
integer
|
Default: 1
|
Number of seconds to sleep between checks.
|
|
|
state
string
|
|
The condition for which the system is waiting.
Defaults to
running, which verifies the specified chassis partition has been created with a status of 'running'.ssh-ready waits for a deployed tenant to be reachable via SSH. |
|
|
timeout
integer
|
Default: 600
|
Maximum number of seconds to wait for the desired state.
|
Examples¶
- name: Wait for the specified partition to be in the running state.
velos_partition_wait:
name: partition1
- name: Wait a maximum of 300 seconds specified partition to be in the api_available state.
velos_partition_wait:
name: partition1
state: ssh-ready
timeout: 300
- name: Wait 30 seconds before verifying the specified partition to be in the running state.
velos_partition_wait:
name: partition1
state: running
delay: 30
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
elapsed
integer
|
always |
Seconds spent waiting for the requested state.
|
|
|
partition_state
complex
|
always |
State data for the specified partition.
|
|
|
controllers
string
|
always |
State of controllers
|
|