Manual Chapter : Tenant CLI command syntax

Applies To:

Show Versions Show Versions

F5OS-A

  • 1.7.0, 1.5.2, 1.5.1, 1.5.0
Manual Chapter

Tenant CLI command syntax

Use the
tenants
command from the CLI to configure a cluster of virtual machines (VMs) that run on one or more nodes within the system
The
tenant
command includes this syntax and these options:
tenants tenant <
options
>
Option
Value
Description
appliance-mode
enabled or disabled (default)
When enabled, appliance-mode disallows root and Bash access for the tenant.
cryptos
enabled or disabled (default)
Specifies the crypto device support for the tenant. When enabled, the tenant receives dedicated crypto devices proportional to the number of vCPU cores. When disabled, the tenant receives no crypto device support.
gateway
IP address
Specifies the IPv4/IPv6 address of the default gateway for the management network. This IP address can be changed on the tenant itself. This field is required.
image
Image name for the tenant
Specifies which software image to install on newly-created virtual disks for this tenant. This field is required.
mac-data
Available options are:
  • one - Represents a block with one MAC.
  • small - Represents a contiguous block of 8 MACs.
  • medium - Represents a contiguous block of 16 MACs.
  • large - Represents a contiguous block of 32 MACs.
Specifies configuration data for MAC block size per tenant.
memory
Memory allocated for the tenant
Specifies the memory in MBs for the tenant. For the commit to succeed, tenant configuration requires the minimum MBs depending on the number of cores specified for the tenant. The administrator must decide what amount of dedicated memory is needed to satisfy the requirements of the modules that will be provisioned within the tenant. For more information on resource allocation, see Tenant resource allocation overviewt.
mgmt-ip
IP address
Specifies the management IP address to the tenant. This address applies to the primary node of the tenant. The address can be changed on the tenant. This field is required.
nodes
Node numbers in square brackets separated by a space. For example, [1 2]
Lists the nodes to which the tenant can be assigned. This field is required.
prefix-length
Decimal value
Specifies the prefix length of the management network. This field is required.
running-state
Configured (default), provisioned, or deployed
Specifies the state of a tenant: configured, provisioned, or deployed. Tenants are in the configured state by default. Configured means the tenant exists but has no hardware resources (CPU or memory) allocated to it and is not running. When the tenant is provisioned, the system assigns the tenant to nodes and creates virtual disks for the tenant on those nodes. In the deployed state, allocated resources are used to launch the tenant VM. Note that specifying deployed causes the actions that occur in the configured and provisioned states. To shut down the tenant VM without removing the virtual disk, change the running-state from deployed to provisioned. Changing the tenant running-state to configured from provisioned or deployed causes its virtual disk to be deleted.
storage
Storage quota in GB for the tenant
Specifies how much storage quota a tenant is allocated. The default size is 77 GB. You cannot modify the size of the virtual disk when the tenant is in the deployed running-state. You can modify the storage size when the tenant is in configured or provisioned running-states. For information on determining minimum disk size, see Tenant sizing.
tenant-auth-storage
trust-mode (F5 r2000/r4000 platforms only)
false (default) or true
Specifies whether a tenant is trusted. MAC masquerade (MM) is required for high availability (HA) on F5 r2000/r4000 platforms, and only between trusted tenants.
This option is available only on F5 r2000/r4000 platforms.
For more information about configuring MM, see K13502: Configuring MAC masquerade (11.x - 17.x).
Enabling trust mode might reduce the security profile of the platform.
type
BIG-IP
(default)
Specifies the supported tenants on the system. The field is not required.
vcpu-cores-per-node
Decimal number
Specifies how many cores a tenant is allocated from each node to which it is assigned. Use tab completion to see a list of possible values on the current
rSeries
system. The default value is 2
virtual-wires
Virtual wire name
Specifies which user-specified virtual-wires to use for the tenant.
vlans
VLAN ID
Specifies the VLAN ID to be used for tenant traffic. To process the traffic through the tenant, make sure the VLAN is configured on the system.