Last updated on: 2024-01-16 03:25:50.

f5os_tenant – Manage F5OS tenants

New in version 1.0.0.

Synopsis

  • Manage F5OS tenants on VELOS Partitions and rSeries platforms.

Parameters

Parameter Choices/Defaults Configuration Comments
cpu_cores
integer
    Choices:
  • 1
  • 2
  • 4
  • 6
  • 8
  • 10
  • 12
  • 14
  • 16
  • 18
  • 20
  • 22
The number of vCPUs added to the tenant.
Required for create operations.
cryptos
string
    Choices:
  • enabled
  • disabled
Whether crypto and compression hardware offload is enabled on the tenant.
F5 recommends enabling, otherwise, crypto and compression can be processed in CPU.
image_name
string
Name of the tenant image to use. Must be present on the chassis partition.
Required for create operations.
memory
integer
The amount of memory (in KB) provided to the tenant.
The configured value of memory must be greater than or equal to the integer value obtained from the formula, '(3.5 * 1024 * cpu_cores) + 512'.
Required for create operations.
mgmt_gateway
string
Tenant management gateway.
mgmt_ip
string
IP address used to connect to the deployed tenant.
Required for create operations.
mgmt_prefix
integer
Tenant management CIDR prefix.
name
string / required
Name of the tenant.
The first character must be a letter.
Only lowercase alphanumeric characters are allowed.
No special or extended characters are allowed except for hyphens.
The name cannot exceed 50 characters.
nodes
list / elements=integer
List of integers. Specifies on which blade nodes the tenants are deployed.
Required for create operations.
For single-blade platforms like rSeries, provide only the value of 1.
running_state
string
    Choices:
  • configured
  • provisioned
  • deployed
Desired running_state of the tenant.
state
string
    Choices:
  • present ←
  • absent
The tenant state. If absent, deletes the tenant if it exists.
If present, the tenant is created and enabled.
vlans
list / elements=integer
The existing VLAN IDs in the chassis partition added to the tenant.
The order of these VLANs is ignored.
This module orders the VLANs automatically. If you deliberately re-order the VLANs in subsequent tasks, then this module will not register a change.
Required for create operations.

Notes

Note

  • The module will create configurations of the tenants. The module does not assume actual state of the running tenant.
  • Deploying tenants is a lengthy process, therefore, the f5os_tenant_wait module is used together with this module to achieve desired results.
  • This module will not execute on VELOS controller.

Examples

- name: Create tenant 'foo'
  f5os_tenant:
    name: foo
    image_name: BIGIP-bigip14.1.x-miro-14.1.2.3-0.0.182.ALL-VELOS.qcow2.zip
    nodes:
      - 1
    mgmt_ip: 10.144.3.17
    mgmt_prefix: 19
    mgmt_gateway: 10.146.127.254
    vlans: [245]
    cpu_cores: 2
    memory: 4096
    cryptos: disabled
    running_state: configured

- name: Deploy tenant 'foo'
  f5os_tenant:
    name: foo
    running_state: deployed

- name: Delete tenant 'foo'
  f5os_tenant:
    name: foo
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
cpu_cores
integer
changed
The number of vCPUs added to the tenant.

Sample:
4
cryptos
string
changed
Specify if crypto and compression hardware offload is enabled for the tenant.

Sample:
enabled
image_name
string
changed
Name of the tenant image.

Sample:
BIGIP-bigip.TMOS-VEL.qcow2.zip
memory
integer
changed
The amount of memory in KB provided to the tenant.

Sample:
4096
mgmt_gateway
string
changed
Tenant management gateway.

Sample:
192.168.1.254
mgmt_ip
string
changed
IP address used to connect to the deployed tenant.

Sample:
192.168.1.1
mgmt_prefix
integer
changed
Tenant management CIDR prefix.

Sample:
24
nodes
list
changed
Specify on which blades the tenant is configured.

Sample:
[1]
running_state
string
changed
The running_state of the tenant.

Sample:
provisioned
vlans
list
changed
Existing VLAN IDs in the chassis partition added to the tenant.

Sample:
[444, 333]


Status

Authors

  • Wojciech Wypior (@wojtek0806)