Manual Chapter :
Tenant CLI command syntax
Applies To:
Show Versions![Show Versions](/etc/designs/pcx/techdocs/images/expandversions.gif)
F5OS-C
- 1.6.2, 1.6.1
Tenant CLI command syntax
Use the
tenants
command from the
chassis partition CLI to configure tenants on a chassis partition.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. |
dag-ipv6-prefix-length | Decimal value | Tenant default value of IPv6 networking mask used by
disaggregator algorithms. |
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:
| Specifies configuration data for MAC
block size per tenant. |
memory | Number in MB; 3840 MB is the minimum
required per vCPU core or min-memory = (3.5 *
1024 * vcpu-cores-per-node) + 512 | Specifies the memory in MBs for the
tenant. For the commit to succeed, tenant configuration
requires the minimum MBs required depending on the number of
cores specified for the tenant. For example, for 2 vCPU cores,
the minimum amount of memory is 7680 MB. The administrator
must decide the amount of dedicated memory needed to satisfy
the requirements of the BIG-IP or BIG-IP Next modules that will be provisioned
within the tenant.The maximum
amount of memory available per blade is 102400
MB. |
mgmt-ip | IP address | Specifies the management IP address
to the tenant. This address floats 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 that the tenant can
be assigned to. This field is required. Specifies the nodes on
the chassis partition on which to provision the tenant. Though
you can specify nodes that are not part of the chassis
partition, the tenant will not be provisioned until the
resources are included in the chassis partition. |
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 put in the
configured state by default. Configured means the tenant
exists on partition, but the tenant has no hardware resources
(CPU or memory) allocated to it and it 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. |
type | BIG-IP (default), BIG-IP Next , or other supported tenant
type | Specifies the supported tenants on
the VELOS system. |
vcpu-cores-per-node | Decimal number | Specifies how many cores a tenant is
allocated from each node that it is assigned to. Use tab
completion to see a list of possible values on the current VELOS system. The
default value is 2 |
virtual-wires | Virtual wire name | User-specified virtual-wires from
virtual-wire table 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 chassis
partition. |