velos_tenant – Manage VELOS tenants

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

Synopsis

  • Manage VELOS tenants.

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 that should be added to the tenant.
Required for create operations.
cryptos
string
    Choices:
  • enabled
  • disabled
Should crypto and compression hardware offload be enabled on the tenant.
We recommend it is enabled, otherwise crypto and compression may be processed in CPU.
image_name
string
Name of the tenant image to be used. Must be present on the chassis partition.
Required for create operations.
memory
integer
The amount of memory that should be provided to the tenant, in KB.
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.
nodes
list / elements=integer
List of integers. Specifies which blades nodes the tenants are deployed on.
Required for create operations.
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 that should be added to the tenant.
The order of these VLANs is ignored.
This module orders the VLANs automatically, if you deliberately re-order them in subsequent tasks, this module will not register a change.
Required for create operations.

Notes

Note

  • The module will create configurations of the tenants, it does not assume actual state of the running tenant.
  • As deployment of tenants is a lengthy process, the module velos_tenant_wait should be used in concert with this module to achieve desired results.

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: Create tenant 'foo'
      velos_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'
      velos_tenant:
        name: foo
        running_state: deployed

    - name: Delete tenant 'foo'
      velos_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 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 tenant.

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

Sample:
[444, 333]


Status

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

Authors

  • Wojciech Wypior (@wojtek0806)