f5networks.f5os.f5os_tenant (1.7.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5os:==1.7.0

Add to requirements.yml

  collections:
    - name: f5networks.f5os
      version: 1.7.0

Description

Manage F5OS tenants on VELOS Partitions and rSeries platforms.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - 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.
    required: true
    type: str

nodes:
    description:
    - List of integers. Specifies on which blade C(nodes) the tenants are deployed.
    - Required for create operations.
    - For single-blade platforms like rSeries, provide only the value of 1.
    elements: int
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The tenant state. If C(absent), deletes the tenant if it exists.
    - If C(present), the tenant is created and enabled.
    type: str

vlans:
    description:
    - 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 B(not) register a change.
    - Required for create operations.
    elements: int
    type: list

memory:
    description:
    - 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.
    type: int

cryptos:
    choices:
    - enabled
    - disabled
    description:
    - Whether crypto and compression hardware offload is enabled on the tenant.
    - F5 recommends enabling, otherwise, crypto and compression can be processed in CPU.
    type: str

mgmt_ip:
    description:
    - IP address used to connect to the deployed tenant.
    - Required for create operations.
    type: str

cpu_cores:
    choices:
    - 1
    - 2
    - 4
    - 6
    - 8
    - 10
    - 12
    - 14
    - 16
    - 18
    - 20
    - 22
    description:
    - The number of vCPUs added to the tenant.
    - Required for create operations.
    type: int

image_name:
    description:
    - Name of the tenant image to use. Must be present on the chassis partition.
    - Required for create operations.
    type: str

mgmt_prefix:
    description:
    - Tenant management CIDR prefix.
    type: int

mgmt_gateway:
    description:
    - Tenant management gateway.
    type: str

running_state:
    choices:
    - configured
    - provisioned
    - deployed
    description:
    - Desired C(running_state) of the tenant.
    type: str

Outputs

cpu_cores:
  description: The number of vCPUs added to the tenant.
  returned: changed
  sample: 4
  type: int
cryptos:
  description: Specify if crypto and compression hardware offload is enabled for the
    tenant.
  returned: changed
  sample: enabled
  type: str
image_name:
  description: Name of the tenant image.
  returned: changed
  sample: BIGIP-bigip.TMOS-VEL.qcow2.zip
  type: str
memory:
  description: The amount of memory in KB provided to the tenant.
  returned: changed
  sample: 4096
  type: int
mgmt_gateway:
  description: Tenant management gateway.
  returned: changed
  sample: 192.168.1.254
  type: str
mgmt_ip:
  description: IP address used to connect to the deployed tenant.
  returned: changed
  sample: 192.168.1.1
  type: str
mgmt_prefix:
  description: Tenant management CIDR prefix.
  returned: changed
  sample: 24
  type: int
nodes:
  description: Specify on which blades the tenant is configured.
  returned: changed
  sample:
  - 1
  type: list
running_state:
  description: The running_state of the tenant.
  returned: changed
  sample: provisioned
  type: str
vlans:
  description: Existing VLAN IDs in the chassis partition added to the tenant.
  returned: changed
  sample:
  - 444
  - 333
  type: list