Last updated on: 2024-05-14 02:50:40.

f5os_tenant_wait – Wait for a F5OS tenant condition before continuing

New in version 1.0.0.

Synopsis

  • Wait for a F5OS tenant to be configured, provisioned, or deployed.

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
    Choices:
  • configured ←
  • provisioned
  • deployed
  • ssh-ready
  • api-ready
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.
api-ready waits for a deployed tenant to be reachable via the REST API.
timeout
integer
Default:
600
Maximum number of seconds to wait for the desired state.

Examples

- name: Wait for the specified tenant to be in the configured state.
  f5os_tenant_wait:
    name: bigip_tenant1

- name: Wait a maximum of 300 seconds specified tenant to be in the provisioned state.
  f5os_tenant_wait:
    name: bigip_tenant1
    state: provisioned
    timeout: 300

- name: Wait 30 seconds before verifying the specified tenant to be in the deployed state.
  f5os_tenant_wait:
    name: bigip_tenant1
    state: deployed
    delay: 30

- name: Wait 30 seconds before verifying the specified tenant to be reachable via the REST API.
  f5os_tenant_wait:
    name: bigip_tenant1
    state: api-ready
    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

Authors

  • Wojciech Wypior (@wojtek0806)