System::VCMP¶
Introduced : BIG-IP_v11.0.0
The vCMP interface allows you to create and maintain vCMP guests and
manage (vCMP) virtual disks. A vCMP guest is one or more virtual
machines (VMs) that together form a TMOS cluster. Note that the
virtual disks are created automatically by the system (one may delete
them, however).
Methods¶
| Method | Description | Introduced |
| add_capability | Adds the specified capabilities to the specified vCMP guests. | BIG-IP_v11.5.0 |
| add_vlan | Adds the specified VLANs to the specified vCMP guests. | BIG-IP_v11.0.0 |
| create | Creates vCMP guests. If you set the guest state to GUEST_STATE_PROVISIONED or higher the system creates and attaches a virtual-disk to the guest if needed. | BIG-IP_v11.0.0 |
| delete_all_guests | Deletes all vCMP guests. | BIG-IP_v11.0.0 |
| delete_all_virtual_disks | Deletes all vCMP virtual disks. | BIG-IP_v11.0.0 |
| delete_guest | Deletes vCMP guests. This deletes any virtual disk attached and deallocates hardware resources on the slots currently occupied. | BIG-IP_v11.0.0 |
| delete_virtual_disk | Deletes vCMP virtual disks. | BIG-IP_v11.0.0 |
| get_all_ha_status_statistics | Gets the HA status statistics for all vCMP guests. | BIG-IP_v11.6.0 |
| get_all_module_provision_statistics | Gets the module provision statistics for all vCMP guests. | BIG-IP_v11.6.0 |
| get_all_prompt_statistics | Gets the prompt statistics for all vCMP guests. | BIG-IP_v11.6.0 |
| get_all_software_statistics | Gets the software statistics for all vCMP guests. | BIG-IP_v11.6.0 |
| get_all_statistics | Gets the statistics for all vCMP guests. | BIG-IP_v11.0.0 |
| get_all_virtual_disk_statistics | Gets the statistics for all vCMP virtual disks. | BIG-IP_v11.2.0 |
| get_capability | Gets the lists of capabilities for the specified vCMP guests. | BIG-IP_v11.5.0 |
| get_capability_value | Gets the lists of values for the capabilities of the specified vCMP guests. | BIG-IP_v11.5.0 |
| get_completion_status | Gets the completion status for the specified guests. The completion status allows you to query the status of a vCMP guest after a state change (see set_guest_state). The system initiates actions to complete a state change, and you can use this method to monitor the change and determine when the change is complete. When checking on completion status, you&aposll get a structure with a number of fields, as detailed in VCMPCompletionStatus. You will get back one list of structures for each vCMP specified, one structure for each slot allocated for the vCMP (depending on your slot allocation setting; if you choose VCMP_SLOT_ALLOCATION_SINGLE there will be just one record at most in the returned data). You can query the Cluster interface to find structural information regarding, for example, how many slots, therefore how many structures to expect. The state in the return value is likely the state you requested for the vCMP guest, but the state could have been set independently. Accordingly, when you poll for status you should check first that this matches what you set. For example, if you asked for the vCMP guest to be provisioned, is the status you are getting back for that request, or did someone else ask for it to be deployed in the meantime? The boolean field “done” indicates whether changes necessary to achieve the desired state are complete, i.e., have reached a “final” status, which allows you to determine in a general way whether you should continue polling for completion. The status field may go through a number of changes as the vCMP processing happens. The comment string gives text-oriented details relevant to the current status, such as reason for failure or percent complete while installing. This is informational and should not be used programmatically. | BIG-IP_v11.0.0 |
| get_guest_allowed_slots | Gets the allowed slots for the specified vCMP guests. | BIG-IP_v11.4.0 |
| get_guest_assigned_slots | Gets the slot allocations for the specified vCMP guests. | BIG-IP_v11.4.0 |
| get_guest_cores_per_slot | Gets the cores per slot for the specified vCMP guests. | BIG-IP_v11.4.0 |
| get_guest_min_slots | Gets the minimum allocated slots for the specified vCMP guests. | BIG-IP_v11.4.0 |
| get_guest_slots | Gets the slots for the specified vCMP guests. | BIG-IP_v11.4.0 |
| get_guest_state | Gets the vCMP guest state to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_ha_status_statistics | Gets the HA status statistics for a list of vCMP guests. | BIG-IP_v11.6.0 |
| get_hostname | Gets the hostnames (FQDN) for the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_initial_image | Gets the initial TMOS software image for the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all vCMP guests. | BIG-IP_v11.0.0 |
| get_management_address | Gets the administration (management) IP addresses for the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_management_gateway | Gets the gateways for the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_module_provision_statistics | Gets the module provision statistics for a list of vCMP guests. | BIG-IP_v11.6.0 |
| get_network_mode | Gets the vCMP network mode to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_prompt_statistics | Gets the prompt statistics for a list of vCMP guests. | BIG-IP_v11.6.0 |
| get_slot_allocation | This method has been deprecated, as it does not represent the full flexible allocation possible in the current release. Gets the slot allocation choices to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_software_statistics | Gets the software statistics for a list of vCMP guests. | BIG-IP_v11.6.0 |
| get_ssl_mode | Gets the vCMP ssl mode to use with the specified vCMP guests. | BIG-IP_v12.0.0 |
| get_statistics | Gets the statistics for a list of vCMP guests. | BIG-IP_v11.0.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.0.0 |
| get_virtual_disk | Gets the virtual disk for the specified vCMP guests. | BIG-IP_v11.0.0 |
| get_virtual_disk_list | Gets a list of all vCMP disks. | BIG-IP_v11.0.0 |
| get_virtual_disk_statistics | Gets the statistics for a list of vCMP virtual disks. | BIG-IP_v11.2.0 |
| get_vlan | Gets the lists of VLANs for the specified vCMP guests. | BIG-IP_v11.0.0 |
| remove_all_capabilities | Removes all capabilities from the specified vCMP guests. | BIG-IP_v11.5.0 |
| remove_all_vlans | Removes all VLANs from the specified vCMP guests. | BIG-IP_v11.0.0 |
| remove_capability | Removes the specified capabilities from the specified vCMP guests. | BIG-IP_v11.5.0 |
| remove_vlan | Removes the specified VLANs from the specified vCMP guests. | BIG-IP_v11.0.0 |
| reset_statistics | Resets the statistics for a list of vCMP guests. | BIG-IP_v11.0.0 |
| set_capability_value | Sets the lists of values for the capabilities of the specified vCMP guests. | BIG-IP_v11.5.0 |
| set_guest_allowed_slots | Sets the allowed slots to use with the specified vCMP guests. | BIG-IP_v11.4.0 |
| set_guest_cores_per_slot | Sets the cores per slot to use with the specified vCMP guests. | BIG-IP_v11.4.0 |
| set_guest_min_slots | Sets the minimum slot allocations to use with the specified vCMP guests. | BIG-IP_v11.4.0 |
| set_guest_slots | Sets the target slot allocation to use with the specified vCMP guests. | BIG-IP_v11.4.0 |
| set_guest_state | Sets the vCMP guest state to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_hostname | Sets the hostnames (FQDN) for the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_initial_image | Sets the initial TMOS software image for the specified vCMP guests. This image is used only when initially creating the virtual disks. After initial creation, the typical Live Install process should be used on the virtual machines to manage software upgrades. The image filename must match a verified software image file that exists in the /shared/images directory. | BIG-IP_v11.0.0 |
| set_management_address | Sets the administration (management) IP addresses for the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_management_gateway | Sets the gateways for the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_network_mode | Sets the vCMP network mode to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_slot_allocation | This method has been deprecated, as it does not represent the full flexible allocation possible in the current release. Sets the slot allocation choices to use with the specified vCMP guests. | BIG-IP_v11.0.0 |
| set_ssl_mode | Sets the vCMP ssl mode to use with the specified vCMP guests. The default value is VCMP_SSL_MODE_SHARED. | BIG-IP_v12.0.0 |
| set_virtual_disk | Sets the virtual disk for the specified vCMP guests. The filename of the virtual disk to use for this guest&aposs virtual machines. This is a hint for the system when it looks for virtual disk files. If set, when a guest moves from the configured state to the provisioned state, the system will look first for a virtual disk file with the given filename in /shared/vmdisks and use it if it exists. If it does not exist, the system will create a virtual disk file with the given filename. If not set, the system will create a new virtual disk file and name it after the guest itself. | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
A structure describing completion status for a vCMP guest.
A struct that describes the statistics for the HA status of a vCMP guest.
A struct that describes vCMP guest HA status statistics and a timestamp describing when the statistics were gathered.
VCMPModuleProvisionStatisticEntry
A struct that describes the statistics for which modules are provisioned inside of a vCMP guest.
A struct that describes vCMP guest module provisioning statistics and a timestamp describing when the statistics were gathered.
A struct that describes the command prompt statistic for vCMP guests.
A struct that describes vCMP guest prompt statistics and timestamp.
A struct that describes the statistics for the installed software on a vCMP guest.
A struct that describes vCMP guest software statistics and a timestamp describing when the statistics were gathered.
A struct that describes statistics for a specified vCMP guest. Each guest has a virtual machine (guest VM) on each of the slots for which it is active. Thus, you can expect a statistics record for each guest and slot on which that guest is present.
A struct that describes vCMP guest statistics and timestamp.
A structure describing (the key for) a virtual-disk.
A struct that describes statistics for a specified virtual disk.
A struct that describes virtual-disk statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| VCMPCapabilityID | A list of capabilities that may be applied to a vCMP guest. |
| VCMPGuestState | A list of vCMP guest states. The system will take actions appropriate to the state requested as shown below. (The system additionally has a status reflecting the progress and results of such actions). Note that moving from the configured state to the deployed state implies the actions that occur in the provisioned state. To shut down a guest&aposs virtual BIG-IPs without de-allocating its hardware resources, move the vCMP guest from the deployed state to the provisioned state. Moving a guest to the configured state causes its hardware resources to be de-allocated. However, doing so does not cause the guest&aposs virtual-disks to be deleted. They persist on disk and are re-used when the vCMP guest moves out of the configured state. |
| VCMPNetworkMode | A list of vCMP Network modes. |
| VCMPOperatingSystem | A list of operating systems that can be installed on a virtual-disk image. This identifies the type of guest operating system stored on the virtual-disk. A virtual-disk with an “unknown” installation cannot be deployed. These virtual-disks are assumed to have no OS installed or a bad installation. |
| VCMPSSLMode | A list of vCMP SSL modes. |
| VCMPSlotAllocation | A list of vCMP slot allocation choices. |
| VCMPStatus | A list of vCMP statuses. These reflect status after a state change (see VCMPGuestState). |
| VirtualDiskStatus | A list of virtual-disk statuses, used by the TMOS Hypervisor to manage disks. |
Aliases¶
| Alias | Type | Description |
| VCMPCapabilityIDSequence | VCMPCapabilityID [] | A sequence of vCMP capability types. |
| VCMPCapabilityIDSequenceSequence | VCMPCapabilityID [] [] | A sequence of vCMP capability ID sequences. |
| VCMPCompletionStatusSequence | VCMPCompletionStatus [] | A sequence of vCMP completion statuses. |
| VCMPCompletionStatusSequenceSequence | VCMPCompletionStatus [] [] | A sequence of vCMP completion sequences. |
| VCMPGuestStateSequence | VCMPGuestState [] | A sequence of vCMP guest states. |
| VCMPHAStatusStatisticEntrySequence | VCMPHAStatusStatisticEntry [] | A sequence of vCMP guest HA status statistics. |
| VCMPModuleProvisionStatisticEntrySequence | VCMPModuleProvisionStatisticEntry [] | A sequence of vCMP guest module provisioning statistics. |
| VCMPNetworkModeSequence | VCMPNetworkMode [] | A sequence of vCMP Network modes. |
| VCMPPromptStatisticEntrySequence | VCMPPromptStatisticEntry [] | A sequence of vCMP guest prompt statistics. |
| VCMPSSLModeSequence | VCMPSSLMode [] | A sequence of vCMP SSL modes |
| VCMPSlotAllocationSequence | VCMPSlotAllocation [] | A sequence of vCMP Slot allocation choices. |
| VCMPSoftwareStatisticEntrySequence | VCMPSoftwareStatisticEntry [] | A sequence of vCMP guest software statistics. |
| VCMPStatisticEntrySequence | VCMPStatisticEntry [] | A sequence of vCMP guest statistics. |
| VCMPStatusSequence | VCMPStatus [] | A sequence of vCMP statuses. |
| VirtualDiskSequence | VirtualDisk [] | A sequence of virtual-disks. |
| VirtualDiskStatisticEntrySequence | VirtualDiskStatisticEntry [] | A sequence of virtual-disk statistics. |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.