4.3. cluster

The cluster resource type groups all host cluster resources in a Red Hat Enterprise Virtualization environment.

Table 4.4. Cluster parameters

Name Type Description Required User Creatable User Updatable
--cpu-id
string
A server CPU reference that defines the CPU type all hosts must support in the cluster.
Yes
Yes
Yes
--data_center-id|name
string
A reference to the data center for a host cluster.
Yes
Yes
No
--name
string
The name of a host cluster.
Yes
Yes
Yes
--version-major
int
The major version number of the cluster. For example, for Red Hat Enterprise Virtualization 3.6, the major version is 3.
Yes
Yes
Yes
--version-minor
int
The minor version number of the cluster. For example, for Red Hat Enterprise Virtualization 3.6, the minor version is 6.
Yes
Yes
Yes
--description
string
A description for the host cluster.
No
Yes
Yes
--error_handling-on_error
string
Defines virtual machine handling when a host within a cluster becomes non-operational, including migrate, do_not_migrate and migrate_highly_available.
No
Yes
Yes
--gluster_service
Boolean
The status is either true or false.
No
Yes
Yes
--memory_policy-overcommit-percent
double
The percentage of host memory allowed in use before a host can no longer run any more virtual machines. Virtual machines can use more than the available host memory due to memory sharing under KSM. Recommended values include 100 (None), 150 (Server Load) and 200 (Desktop Load).
No
Yes
Yes
--memory_policy-transparent_hugepages-enabled
Boolean
Defines the enabled status of Transparent Hugepages. The status is either true or false.
No
Yes
Yes
--scheduling_policy-policy
string
The VM scheduling mode for hosts in the cluster, such as evenly_distributed, power_saving or blank for none.
No
Yes
Yes
--scheduling_policy-thresholds-duration
int
The number of seconds the host can be overloaded before the scheduler starts and moves the load to another host.
No
Yes
Yes
--scheduling_policy-thresholds-high
int
Controls the highest CPU usage percentage the host can have before being considered overloaded.
No
Yes
Yes
--scheduling_policy-thresholds-low
int
Controls the lowest CPU usage percentage the host can have before being considered underutilized.
No
Yes
Yes
--threads_as_cores
Boolean
Hosts treat threads as cores, allowing hosts to run virtual machines with a total number of processor cores greater than the number of cores in the host. The status is either true or false.
No
No
No
--trusted_service
Boolean
Defines whether an OpenAttestation server is used to verify hosts.
No
Yes
Yes
--virt_service
Boolean
The status is either true or false.
No
Yes
Yes
--expect
'201-created'
Request becomes asynchronous until the expected HTTP header is returned. Useful for long-running tasks that would otherwise return as successful before the task is completed.
No
No
No
--correlation_id
string
A tagging identifier of an action for cross-system logging. If the client does not define the identifier, one will be generated.
No
Yes
No

Example 4.5. Creating a new cluster

[RHEVM shell (connected)]# add cluster --name Engineering --cpu-id "Intel Penryn Family" --datacenter-name Default --version-major 3 --version-minor 2

Example 4.6. Updating a cluster

[RHEVM shell (connected)]# update cluster Engineering --name Finance

Example 4.7. Deleting a cluster

[RHEVM shell (connected)]# remove cluster Engineering