f5networks / f5networks.f5os / 1.7.0 / module / f5os_tenant_wait Wait for a F5OS tenant condition before continuing | "added in version" 1.0.0 of f5networks.f5os" Authors: Wojciech Wypior (@wojtek0806)f5networks.f5os.f5os_tenant_wait (1.7.0) — module
Install with ansible-galaxy collection install f5networks.f5os:==1.7.0
collections: - name: f5networks.f5os version: 1.7.0
Wait for a F5OS tenant to be C(configured), C(provisioned), or C(deployed).
- 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
msg: description: - This overrides the normal error message from a failure to meet the required conditions. type: str name: description: - Name of the tenant. required: true type: str delay: default: 0 description: - Number of seconds to wait before starting to poll. type: int sleep: default: 1 description: - Number of seconds to sleep between checks. type: int state: choices: - configured - provisioned - deployed - ssh-ready - api-ready default: configured description: - The condition for which the system is waiting. - Defaults to C(configured), which verifies the specified tenant has been created on the partition and is in the configured run-state. - C(provisioned) waits for the tenant running-state and status "provisioned". - C(deployed) waits for the tenant running-state "deployed", status "running", and phase "running". - C(ssh-ready) waits for a deployed tenant to be reachable via SSH. - C(api-ready) waits for a deployed tenant to be reachable via the REST API. type: str timeout: default: 600 description: - Maximum number of seconds to wait for the desired state. type: int
elapsed: description: Seconds spent waiting for the requested state. example: 600 returned: always type: int tenant_state: contains: blades: description: Blades allocated to tenant. example: 1 returned: always type: int cpu-cores: description: CPU Cores allocated to the tenant. example: '1' returned: always type: str cryptos: description: Tenant crypto state. Enabled or Disabled. example: disabled returned: always type: str instances: description: Tenant instance details. example: hash/dictionary of values returned: always type: dict mac-data: description: Tenant MAC pool details. example: hash/dictionary of values returned: always type: dict memory: description: Memory allocated to the tenant. example: '4092' returned: always type: str name: description: Name of the tenant. example: defaultbip returned: always type: str running-state: description: Tenant running state. example: defaultbip returned: always type: str status: description: Tenant Running state. example: Running returned: always type: str type: description: Tenant type. example: BIG-IP returned: always type: str description: State data for the specified tenant. returned: always type: complex