System::VCMP::VCMPGuestState

Introduced : BIG-IP_v11.0.0
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.

Members

Member

Value

Description

VCMP_GUEST_STATE_UNKNOWN

0

Guest state is unknown (or is unsupported by iControl).

VCMP_GUEST_STATE_CONFIGURED

1

Guest exists as a configuration object, but has no hardware resources allocated to it and has no VMs running.

VCMP_GUEST_STATE_PROVISIONED

2

Guest has hardware resources allocated but no VMs running. A virtual disk will be created and the initial software image will be installed.

VCMP_GUEST_STATE_DEPLOYED

3

Guest has hardware resources and should have VMs running. The system tries to launch and keep running any VMs belonging to vCMP guests in the deployed state.

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.