Try SpotterManages vCMP guests on a BIG-IP
| "added in version" 1.1.0 of f5networks.f5_bigip"
Authors: Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0
collections:
- name: f5networks.f5_bigip
version: 3.4.0Manages vCMP (Virtual Clustered Multiprocessing) guests on a BIG-IP. This functionality only exists on actual hardware and must be enabled by provisioning C(VCMP) with the C(bigip_do_deploy) module.
- name: Create a vCMP guest
bigip_vcmp_guest:
name: foo
mgmt_network: bridge
mgmt_address: 10.20.30.40/24
- 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
- name: Remove vCMP guest and disk
bigip_vcmp_guest:
name: guest1
state: absent
delete_virtual_disk: true
name:
description:
- The name of the vCMP guest to manage.
required: true
type: str
state:
choices:
- configured
- disabled
- provisioned
- present
- absent
default: present
description:
- The state of the vCMP guest on the system. Each state implies the actions of all
states before it.
- When C(configured), guarantees the vCMP guest exists with the provided attributes.
Additionally, ensures the vCMP guest is turned off.
- When C(disabled), behaves the same way as C(configured), it is just a more user-friendly
name.
- When C(provisioned), ensures the guest is created and installed. This state does
not start the guest; use C(deployed) for that purpose. This state is one step beyond
C(present), as C(present) does not install the guest; only sets up the configuration
for it to be installed.
- When C(present), ensures the guest is properly provisioned and starts the guest
so that it is in a running state.
- When C(absent), removes the vCMP from the system.
type: str
vlans:
description:
- 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 B(not) register a change.
elements: str
type: list
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
mgmt_route:
description:
- Specifies the gateway address for the C(mgmt_address).
- If this value is not specified when creating a new guest, it is set to C(none).
- The value C(none) can be used during an update to remove this value.
type: str
mgmt_address:
description:
- 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 C(mgmt_network) parameter is C(bridged).
- When creating a new guest, if you do not specify a network or network mask, a default
of C(/24) (C(255.255.255.0)) is used.
type: str
mgmt_network:
choices:
- bridged
- isolated
- host only
description:
- Specifies the method by which the management address is used in the vCMP guest.
- When C(bridged), specifies the guest can communicate with the vCMP host's management
network.
- When C(isolated), specifies the guest is isolated from the vCMP host's management
network. In this case, the only way a guest can communicate with the vCMP host is
through the console port or through a self IP address on the guest that allows traffic
through port 22.
- When C(host only), prevents the guest from installing images and hotfixes other
than those provided by the hypervisor.
- If the guest setting is C(isolated) or C(host only), the C(mgmt_address) does not
apply.
- For mode changing, changing C(bridged) to C(isolated) causes the vCMP host to remove
all of the guest's management interfaces from its bridged management network. This
immediately disconnects the guest's VMs from the physical management network. Changing
C(isolated) to C(bridged) causes the vCMP host to dynamically add the guest's management
interfaces to the bridged management network. This immediately connects all of the
guest's VMs to the physical management network. Changing this property while the
guest is in the C(configured) or C(provisioned) state has no immediate effect.
type: str
allowed_slots:
description:
- 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 C(allowed_slots) on two guests, that those guests are never
assigned to the same slot.
- By default, this list includes every available slot in the cluster. This means the
guest may be assigned to any slot by default.
elements: str
type: list
initial_image:
description:
- 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.
type: str
cores_per_slot:
description:
- 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.
type: int
initial_hotfix:
description:
- Specifies the hotfix ISO image file which is applied on top of the base image.
type: str
number_of_slots:
description:
- 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.
type: int
delete_virtual_disk:
default: false
description:
- When C(state) is C(absent), the system additionally deletes the virtual disk associated
with the vCMP guest. By default, this value is C(false).
type: bool
min_number_of_slots:
description:
- 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 C(min_number_of_slots) value cannot be greater than its C(number_of_slots).
type: int
vlans: description: The VLANs assigned to the vCMP guest, in their full path format. returned: changed sample: - /Common/vlan1 - /Common/vlan2 type: list