Module cmdlib

Returns list of checked and expanded node names.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• nodes (list) - list of node names or None for all nodes

Returns: list

the list of nodes, sorted

Raises:

• errors.ProgrammerError - if the nodes parameter is wrong type

Returns list of checked and expanded instance names.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instances (list) - list of instance names or None for all instances

Returns: list

the list of instances, sorted

Raises:

• errors.OpPrereqError - if the instances parameter is wrong type
• errors.OpPrereqError - if any of the passed instances is not found

Return the new version of a parameter dictionary.

Parameters:

• old_params (dict) - old parameters
• update_dict (dict) - dict containing new parameter values, or constants.VALUE_DEFAULT to reset the parameter to its default value
• use_default (whether to recognise constants.VALUE_DEFAULT values as 'to be deleted' values) - boolean
• use_none (whether to recognise None values as 'to be deleted' values) - boolean

Returns: dict

the new parameter dictionary

Checks whether all selected fields are valid.

Parameters:

• static (utils.FieldSet) - static fields set
• dynamic (utils.FieldSet) - dynamic fields set

Validates that given hypervisor params are not global ones.

This will ensure that instances don't get customised versions of global params.

Ensure that a given node is online.

Parameters:

• lu - the LU on behalf of which we make the check
• node - the node to check
• msg - if passed, should be a message to replace the default one

Raises:

• errors.OpPrereqError - if the node is offline

Ensure that a given node is not drained.

Parameters:

• lu - the LU on behalf of which we make the check
• node - the node to check

Raises:

• errors.OpPrereqError - if the node is drained

Ensure that a given node is vm capable.

Parameters:

• lu - the LU on behalf of which we make the check
• node - the node to check

Raises:

• errors.OpPrereqError - if the node is not vm capable

Ensure that a node supports a given OS.

Parameters:

• lu - the LU on behalf of which we make the check
• node - the node to check
• os_name - the OS to query about
• force_variant - whether to ignore variant errors

Raises:

• errors.OpPrereqError - if the node is not supporting the OS

Ensure that a node has the given secondary ip.

Parameters:

• lu (LogicalUnit) - the LU on behalf of which we make the check
• node (string) - the node to check
• secondary_ip (string) - the ip to check
• prereq (boolean) - whether to throw a prerequisite or an execute error

Raises:

• errors.OpPrereqError - if the node doesn't have the ip, and prereq=True
• errors.OpExecError - if the node doesn't have the ip, and prereq=False

Checks that file storage is enabled.

Raises:

• errors.OpPrereqError - when file storage is disabled

Expand an item name.

Parameters:

• fn - the function to use for expansion
• name - requested item name
• kind - text description ('Node' or 'Instance')

Returns:

the resolved (full) name

Raises:

• errors.OpPrereqError - if the item is not found

Builds instance related env variables for hooks

This builds the hook environment from individual variables.

Parameters:

• name (string) - the name of the instance
• primary_node (string) - the name of the instance's primary node
• secondary_nodes (list) - list of secondary nodes as strings
• os_type (string) - the name of the instance's OS
• status (boolean) - the should_run status of the instance
• memory (string) - the memory size of the instance
• vcpus (string) - the count of VCPUs the instance has
• nics (list) - list of tuples (ip, mac, mode, link) representing the NICs the instance has
• disk_template (string) - the disk template of the instance
• disks (list) - the list of (size, mode) pairs
• bep (dict) - the backend parameters for the instance
• hvp (dict) - the hypervisor parameters for the instance
• hypervisor_name (string) - the hypervisor for the instance

Returns: dict

the hook environment for this instance

Build a list of nic information tuples.

This list is suitable to be passed to _BuildInstanceHookEnv or as a return value in LUQueryInstanceData.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• nics (list of objects.NIC) - list of nics to convert to hooks tuples

Builds instance related env variables for hooks from an object.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance for which we should build the environment
• override (dict) - dictionary with key/values that will override our values

Returns: dict

the hook environment dictionary

Check whether an OS name conforms to the os variants specification.

Parameters:

• os_obj (objects.OS) - OS object to check
• name (string) - OS name passed by the user, to check for validity

Check the sanity of iallocator and node arguments and use the cluster-wide iallocator if appropriate.

Check that at most one of (iallocator, node) is specified. If none is specified, then the LU's opcode's iallocator slot is filled with the cluster-wide default iallocator.

Parameters:

• iallocator_slot (string) - the name of the opcode iallocator slot
• node_slot (string) - the name of the opcode target node slot

Verifies a certificate for LUVerifyCluster.

Parameters:

• filename (string) - Path to PEM file

Distribute additional files which are part of the cluster configuration.

ConfigWriter takes care of distributing the config and ssconf files, but there are more files which should be distributed to all nodes. This function makes sure those are copied.

Parameters:

• lu - calling logical unit
• additional_nodes - list of nodes not in the config to distribute to
• additional_vm (boolean) - whether the additional nodes are vm-capable or not

Check that mirrors are not degraded.

The ldisk parameter, if True, will change the test from the is_degraded attribute (which represents overall non-ok status for the device(s)) to the ldisk (representing the local storage status).

Prepare the block devices for an instance.

This sets up the block devices on all nodes.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance for whose disks we assemble
• disks (list of objects.Disk or None) - which disks to assemble (or all, if None)
• ignore_secondaries (boolean) - if true, errors on secondary nodes won't result in an error return from the function
• ignore_size (boolean) - if true, the current known size of the disk will not be used during the disk activation, useful for cases when the size is wrong

Returns:

False if the operation failed, otherwise a list of (host, instance_visible_name, node_visible_name) with the mapping from node devices to instance devices

Shutdown block devices of an instance.

This function checks if an instance is running, before calling _ShutdownInstanceDisks.

Return the instance disks selected by the disks list

Parameters:

• disks (list of objects.Disk or None) - selected disks

Returns: list of objects.Disk

selected instance disks to act on

Shutdown block devices of an instance.

This does the shutdown on all nodes of the instance.

If the ignore_primary is false, errors on the primary node are ignored.

Checks if a node has enough free memory.

This function check if a given node has the needed amount of free memory. In case the node has less memory or we cannot get the information from the node, this function raise an OpPrereqError exception.

Parameters:

• lu (LogicalUnit) - a logical unit from which we get configuration data
• node (str) - the node to check
• reason (str) - string to use in the error message
• requested (int) - the amount of memory in MiB to check for
• hypervisor_name (str) - the hypervisor to ask for memory stats

Raises:

• errors.OpPrereqError - if the node doesn't have enough memory, or we cannot check the node

Checks if nodes have enough free disk space in the default VG.

This function check if all given nodes have the needed amount of free disk. In case any node has less disk or we cannot get the information from the node, this function raise an OpPrereqError exception.

Parameters:

• lu (LogicalUnit) - a logical unit from which we get configuration data
• nodenames (list) - the list of node names to check
• requested (int) - the amount of disk in MiB to check for

Raises:

• errors.OpPrereqError - if the node doesn't have enough disk, or we cannot check the node

Create a tree of block devices on a given node.

If this device type has to be created on secondaries, create it and all its children.

If not, just recurse to children keeping the same 'force' value.

Parameters:

• lu - the lu on whose behalf we execute
• node - the node on which to create the device
• instance (objects.Instance) - the instance which owns the device
• device (objects.Disk) - the device to create
• force_create (boolean) - whether to force creation of this device; this will be change to True whenever we find a device which has CreateOnSecondary() attribute
• info - the extra 'metadata' we should attach to the device (this will be represented as a LVM tag)
• force_open (boolean) - this parameter will be passes to the backend.BlockdevCreate function where it specifies whether we run on primary or not, and it affects both the child assembly and the device own Open() execution

Create a single block device on a given node.

This will not recurse over children of the device, so they must be created in advance.

Parameters:

• lu - the lu on whose behalf we execute
• node - the node on which to create the device
• instance (objects.Instance) - the instance which owns the device
• device (objects.Disk) - the device to create
• info - the extra 'metadata' we should attach to the device (this will be represented as a LVM tag)
• force_open (boolean) - this parameter will be passes to the backend.BlockdevCreate function where it specifies whether we run on primary or not, and it affects both the child assembly and the device own Open() execution

Generate a suitable LV name.

This will generate a logical volume name for the given instance.

Calculates the ETA based on size written and total size.

Parameters:

• time_taken - The time taken so far
• written - amount written so far
• total_size - The total size of data to be written

Returns:

The remaining time in seconds

Wipes instance disks.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance whose disks we should create

Returns:

the success of the wipe

Create all disks for an instance.

This abstracts away some work from AddInstance.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance whose disks we should create
• to_skip (list) - list of indices to skip
• target_node (string) - if passed, overrides the target node for creation

Returns: boolean

the success of the creation

Remove all disks for an instance.

This abstracts away some work from `AddInstance()` and `RemoveInstance()`. Note that in case some of the devices couldn't be removed, the removal will continue with the other ones (compare with `_CreateDisks()`).

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance whose disks we should remove
• target_node (string) - used to override the node on which to remove the disks

Returns: boolean

the success of the removal

Hypervisor parameter validation.

This function abstract the hypervisor parameter validation to be used in both instance create and instance modify.

Parameters:

• lu (LogicalUnit) - the logical unit for which we check
• nodenames (list) - the list of nodes on which we should check
• hvname (string) - the name of the hypervisor we should use
• hvparams (dict) - the parameters which we need to check

Raises:

• errors.OpPrereqError - if the parameters are not valid

OS parameters validation.

Parameters:

• lu (LogicalUnit) - the logical unit for which we check
• required (boolean) - whether the validation should fail if the OS is not found
• nodenames (list) - the list of nodes on which we should check
• osname (string) - the name of the hypervisor we should use
• osparams (dict) - the parameters which we need to check

Raises:

• errors.OpPrereqError - if the parameters are not valid

_POutputFields

output fields for a query operation

Value:

"output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)

_PShutdownTimeout

the shutdown timeout

Value:

"shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveIn t

_PInstanceName

a required instance name (for single-instance LUs)

Value:

"instance_name", ht.NoDefault, ht.TNonEmptyString

_PMigrationMode

the migration type (live/non-live)

Value:

"mode", None, ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES ))