velos_partition_wait – Wait for a VELOS chassis partition to match a condition before continuing

New in version 1.3.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.velos_partition_wait instead.

Synopsis

  • Wait for VELOS chassis partition to match a condition before continuing.

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
    Choices:
  • running ←
  • ssh-ready
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

- 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 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


Status

  • This module will be removed in version 2.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Ravinder Reddy (@chinthalapalli)