f5networks.f5_modules.bigip_vcmp_guest module – Manages vCMP guests on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_vcmp_guest
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages vCMP (Virtual Clustered Multiprocessing) guests on a BIG-IP. This functionality only exists on actual hardware and must be enabled by provisioning
vcmp
with thebigip_provision
module.
Parameters
Parameter |
Comments |
---|---|
Contains those slots to which the guest is allowed to be assigned. When the host determines which slots this guest should be assigned, only slots in this list are considered. This is a good way to force guests to be assigned only to particular slots, or, by configuring disjoint By default, this list includes every available slot in the cluster. This means the guest may be assigned to any slot by default. |
|
Specifies the number of cores the system allocates to the guest. Each core represents a portion of CPU and memory. Therefore, the amount of memory allocated per core is directly tied to the amount of CPU. This amount of memory varies per hardware platform type. The number you can specify depends on the type of hardware you have. In the event of a reboot, the system persists the guest to the same slot on which it ran prior to the reboot. |
|
When Choices:
|
|
Specifies the hotfix ISO image file which is applied on top of the base image. |
|
Specifies the base software release ISO image file for installing the TMOS hypervisor instance and any licensed BIG-IP modules onto the guest’s virtual disk. When creating a new guest, this parameter is required. Ensure this image is present on the VCMP host and not only on the VCMP guest. Also, the file reference for this image should be the one present on the host and not on the guest. |
|
Specifies the IP address and subnet or subnet mask you use to access the guest when you want to manage a module running within the guest. This parameter is required if the When creating a new guest, if you do not specify a network or network mask, a default of |
|
Specifies the method by which the management address is used in the vCMP guest. When When When If the guest setting is For mode changing, changing Choices:
|
|
Specifies the gateway address for the If this value is not specified when creating a new guest, it is set to The value |
|
Specifies the minimum number of slots the guest must be assigned to in order to deploy. This field dictates the number of slots to which the guest must be assigned. At the end of any allocation attempt, if the guest is not assigned to at least this many slots, the attempt fails and the change that initiated it is reverted. A guest’s |
|
The name of the vCMP guest to manage. |
|
Specifies the number of slots for the system to use when creating the guest. This value dictates how many cores a guest is allocated from each slot to which it is assigned. Possible values are dependent on the type of blades being used in this cluster. The default value depends on the type of blades being used in this cluster. |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
The state of the vCMP guest on the system. Each state implies the actions of all states before it. When When When When When Choices:
|
|
VLANs the guest uses to communicate with other guests, the host, and with the external network. The available VLANs in the list are those that are currently configured on the vCMP host. The order of these VLANs is not important and is ignored. This module orders the VLANs automatically. Therefore, if you deliberately re-order them in subsequent tasks, this module does not register a change. |
Notes
Note
This module can take a lot of time to deploy vCMP guests. This is an intrinsic limitation of the vCMP system, because it is booting real VMs on the BIG-IP device. This boot time is very similar in length to the time it takes to boot VMs on any other virtualization platform; public or private.
When BIG-IP starts, the VMs are booted sequentially; not in parallel. This means it is not unusual for a vCMP host with many guests to take a long time (60+ minutes) to reboot and bring all the guests online. The BIG-IP chassis will be available before all vCMP guests are online.
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a vCMP guest
bigip_vcmp_guest:
name: foo
mgmt_network: bridge
mgmt_address: 10.20.30.40/24
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a vCMP guest with specific VLANs
bigip_vcmp_guest:
name: foo
mgmt_network: bridge
mgmt_address: 10.20.30.40/24
vlans:
- vlan1
- vlan2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove vCMP guest and disk
bigip_vcmp_guest:
name: guest1
state: absent
delete_virtual_disk: true
provider:
password: secret
server: lb.mydomain.com
user: admin
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The VLANs assigned to the vCMP guest, in their full path format. Returned: changed Sample: |