velos_tenant_wait – Wait for a VELOS condition before continuing¶
New in version 1.1.0.
DEPRECATED¶
Removed in F5 BIGIP Collection version: | |
---|---|
2.0.0 | |
Why: | All VELOS related modules have been moved to a dedicated collection for managing F5OS based devices. |
Alternative: | Use f5networks.f5os.f5os_tenant_wait instead. |
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 tenant.
|
||
sleep
integer
|
Default: 1
|
Number of seconds to sleep between checks.
|
|
state
string
|
|
The condition for which the system is waiting.
Defaults to
configured , which verifies the specified tenant has been created on the partition and is in the configured run-state.provisioned waits for the tenant running-state and status "provisioned".deployed waits for the tenant running-state "deployed", status "running", and phase "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¶
- hosts: all
collections:
- f5networks.f5_bigip
connection: httpapi
vars:
ansible_host: "lb.mydomain.com"
ansible_user: "admin"
ansible_httpapi_password: "secret"
ansible_network_os: f5networks.f5_bigip.velos
ansible_httpapi_use_ssl: yes
tasks:
- name: Wait for the specified tenant to be in the configured state.
velos_tenant_wait:
name: bigip_tenant1
- name: Wait a maximum of 300 seconds specified tenant to be in the provisioned state.
velos_tenant_wait:
name: bigip_tenant1
state: provisioned
timeout: 300
- name: Wait 30 seconds before verifying the specified tenant to be in the deployed state.
velos_tenant_wait:
name: bigip_tenant1
state: deployed
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.
|
|
tenant_state
complex
|
always |
State data for the specified tenant.
|
|
blades
integer
|
always |
Blades allocated to tenant.
|
|
cpu-cores
string
|
always |
CPU Cores allocated to the tenant.
|
|
cryptos
string
|
always |
Tenant crypto state. Enabled or Disabled.
|
|
instances
dictionary
|
always |
Tenant instance details.
|
|
mac-data
dictionary
|
always |
Tenant MAC pool details.
|
|
memory
string
|
always |
Memory allocated to the tenant.
|
|
name
string
|
always |
Name of the tenant.
|
|
running-state
string
|
always |
Tenant running state.
|
|
status
string
|
always |
Tenant Running state.
|
|
type
string
|
always |
Tenant type.
|
Status¶
- This module will be removed in version 2.0.0. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Wojciech Wypior (@wojtek0806)