Module cmdlib

Little helper wrapper to the rpc annotation method.

Parameters:

• instance - The instance object
• devs (List of objects.Disk) - The root devices (not any of its children!)
• cfg - The config object @returns The annotated disk copies @see rpc.AnnotateDiskParams

Checks if node groups for locked instances are still correct.

Parameters:

• cfg (config.ConfigWriter) - Cluster configuration
• instances (dict; string as key, objects.Instance as value) - Dictionary, instance name as key, instance object as value
• owned_groups (iterable of string) - List of owned groups
• owned_nodes (iterable of string) - List of owned nodes
• cur_group_uuid (string or None) - Optional group UUID to check against instance's groups

Checks if the owned node groups are still correct for an instance.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• instance_name (string) - Instance name
• owned_groups (set or frozenset) - List of currently owned node groups
• primary_only (boolean) - Whether to check node groups for only the primary node

Checks if the instances in a node group are still correct.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• group_uuid (string) - Node group UUID
• owned_instances (set or frozenset) - List of currently owned instances

Tells if node supports OOB.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• node (objects.Node) - The node

Returns:

The OOB script if supported or an empty string otherwise

Whether exclusive_storage is in effect for the given node.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• node (objects.Node) - The node

Returns: bool

The effective value of exclusive_storage

Whether exclusive_storage is in effect for the given node.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• nodename (string) - The node

Returns: bool

The effective value of exclusive_storage

Raises:

• errors.OpPrereqError - if no node exists with the given name

Makes a copy of a list of lock names.

Handles locking.ALL_SET correctly.

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

Return the new version of a instance policy.

Parameters:

• group_policy - whether this policy applies to a group and thus we should support removal of policy entries

Updates and verifies a dict with sub dicts of the same type.

Parameters:

• base - The dict with the old data
• updates - The dict with the new data
• type_check - Dict suitable to ForceDictType to verify correct types

Returns:

A new dict with updated and verified values

Combines the hv state from an opcode with the one of the object

Parameters:

• op_input - The input dict from the opcode
• obj_input - The input dict from the objects

Returns:

The verified and updated dict

Combines the disk state from an opcode with the one of the object

Parameters:

• op_input - The input dict from the opcode
• obj_input - The input dict from the objects

Returns:

The verified and updated dict

Releases locks owned by an LU.

Parameters:

• level - Lock level
• names (list or None) - Names of locks to release
• keep (list or None) - Names of locks to retain
• lu (LogicalUnit)

Creates a map from (node, volume) to instance name.

Parameters:

• instances (list of objects.Instance)

Returns: dict; tuple of (node name, volume name) as key, instance name as value

Checks whether all selected fields are valid.

Parameters:

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

Make sure that none of the given paramters is global.

If a global parameter is found, an errors.OpPrereqError exception is raised. This is used to avoid setting global parameters for individual nodes.

Parameters:

• params (dictionary) - Parameters to check
• glob_pars (dictionary) - Forbidden parameters
• kind (string) - Kind of parameters (e.g. "node")
• bad_levels (string) - Level(s) at which the parameters are forbidden (e.g. "instance")
• good_levels (strings) - Level(s) at which the parameters are allowed (e.g. "cluster or group")

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

Ensure that an instance is in one of the required states.

Parameters:

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

Raises:

• errors.OpPrereqError - if the instance is not in the required state

Computes if value is in the desired range.

Parameters:

• name - name of the parameter for which we perform the check
• qualifier - a qualifier used in the error message (e.g. 'disk/1', not just 'disk')
• ipolicy - dictionary containing min, max and std values
• value - actual value that we want to use

Returns:

None or element not meeting the criteria

Verifies ipolicy against provided specs.

Parameters:

• ipolicy (dict) - The ipolicy
• mem_size (int) - The memory size
• cpu_count (int) - Used cpu cores
• disk_count (int) - Number of disks used
• nic_count (int) - Number of nics used
• disk_sizes (list of ints) - Disk sizes of used disk (len must match disk_count)
• spindle_use (int) - The number of spindles this instance uses
• disk_template (string) - The disk template of the instance
• _compute_fn - The compute function (unittest only)

Returns:

A list of violations, or an empty list of no violations are found

Compute if instance meets the specs of ipolicy.

Parameters:

• ipolicy (dict) - The ipolicy to verify against
• instance (objects.Instance) - The instance to verify
• cfg (config.ConfigWriter) - Cluster configuration
• _compute_fn - The function to verify ipolicy (unittest only)

Compute if instance specs meets the specs of ipolicy.

Parameters:

• ipolicy (dict) - The ipolicy to verify against
• instance_spec - dict
• instance_spec - The instance spec to verify
• disk_template (string) - the disk template of the instance
• _compute_fn - The function to verify ipolicy (unittest only)

Compute if instance meets the specs of the new target group.

Parameters:

• ipolicy - The ipolicy to verify
• instance - The instance object to verify
• current_group - The current group of the instance
• target_group - The new group of the instance
• cfg (config.ConfigWriter) - Cluster configuration
• _compute_fn - The function to verify ipolicy (unittest only)

Checks that the target node is correct in terms of instance policy.

Parameters:

• ipolicy - The ipolicy to verify
• instance - The instance object to verify
• node - The new node to relocate
• cfg (config.ConfigWriter) - Cluster configuration
• ignore - Ignore violations of the ipolicy
• _compute_fn - The function to verify ipolicy (unittest only)

Computes a set of any instances that would violate the new ipolicy.

Parameters:

• old_ipolicy - The current (still in-place) ipolicy
• new_ipolicy - The new (to become) ipolicy
• instances - List of instances to verify
• cfg (config.ConfigWriter) - Cluster configuration

Returns:

A list of instances which violates the new ipolicy but did not before

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 network related env variables for hooks

This builds the hook environment from individual variables.

Parameters:

• name (string) - the name of the network
• subnet (string) - the ipv4 subnet
• gateway (string) - the ipv4 gateway
• network6 (string) - the ipv6 subnet
• gateway6 (string) - the ipv6 gateway
• mac_prefix (string) - the mac_prefix
• tags (list) - the tags of the network

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 (string) - the desired status of the instance
• minmem (string) - the minimum memory size of the instance
• maxmem (string) - the maximum memory size of the instance
• vcpus (string) - the count of VCPUs the instance has
• nics (list) - list of tuples (ip, mac, mode, link, net, netinfo) 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
• tags (list) - list of instance tags as strings

Returns: dict

the hook environment for this instance

Build a tupple of nic information.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• nic (objects.NIC) - nic to convert to hooks tuple

Build a list of nic information tuples.

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

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

Computes a set of instances who violates given ipolicy.

Parameters:

• ipolicy - The ipolicy to verify
• instances (objects.Instance) - List of instances to verify
• cfg (config.ConfigWriter) - Cluster configuration

Returns:

A frozenset of instance names violating the ipolicy

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, or the iallocator is constants.DEFAULT_IALLOCATOR_SHORTCUT, 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

Decides on which iallocator to use.

Parameters:

• cfg (config.ConfigWriter) - Cluster configuration object
• ialloc (string or None) - Iallocator specified in opcode

Returns: string

Iallocator name

Ensures that a given hostname resolves to a 'sane' name.

The given name is required to be a prefix of the resolved hostname, to prevent accidental mismatches.

Parameters:

• lu - the logical unit on behalf of which we're checking
• name - the name we should resolve and check

Returns:

the resolved hostname object

Verifies a certificate for LUClusterVerifyConfig.

Parameters:

• filename (string) - Path to PEM file

Compute the set of all hypervisor parameters.

Parameters:

• cluster (objects.Cluster) - the cluster object
• instances - list of objects.Instance
• instances - additional instances from which to obtain parameters

Returns: list of (origin, hypervisor, parameters)

a list with all parameters found, indicating the hypervisor they apply to, and the origin (can be "cluster", "os X", or "instance Y")

Checks if a netmask is valid.

Parameters:

• cfg (config.ConfigWriter) - The cluster configuration
• netmask (int) - the netmask to be verified

Raises:

• errors.OpPrereqError - if the validation fails

Compute files external to Ganeti which need to be consistent.

Parameters:

• redist (boolean) - Whether to include files which need to be redistributed

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

Wrapper around call_blockdev_find to annotate diskparams.

Parameters:

• lu - A reference to the lu object
• node - The node to call out
• dev - The device to find
• instance - The instance object the device belongs to @returns The result of the rpc call

Check that mirrors are not degraded.

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 checks 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 raises 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

Returns: integer

node current free memory

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 all the VGs.

This function checks 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 raises an OpPrereqError exception.

Parameters:

• lu (LogicalUnit) - a logical unit from which we get configuration data
• nodenames (list) - the list of node names to check
• req_sizes (dict) - the hash of vg and corresponding 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

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

This function checks 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 raises an OpPrereqError exception.

Parameters:

• lu (LogicalUnit) - a logical unit from which we get configuration data
• nodenames (list) - the list of node names to check
• vg (str) - the volume group 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

Checks if nodes have enough physical CPUs

This function checks if all given nodes have the needed number of physical CPUs. In case any node has less CPUs or we cannot get the information from the node, this function raises 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 minimum acceptable number of physical CPUs

Raises:

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

Expands names for use with TLMigrateInstance.

Parameters:

• lu (LogicalUnit)

Declares locks for TLMigrateInstance.

Parameters:

• level - Lock level
• lu (LogicalUnit)

Wrapper around _CreateBlockDevInner.

This method annotates the root device first.

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
• excl_stor (boolean) - Whether exclusive_storage is active for the node

Returns:

list of created devices

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
• excl_stor (boolean) - Whether exclusive_storage is active for the node

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
• disks (None or list of tuple of (number, objects.Disk, number)) - Disk details; tuple contains disk index, disk object and the start offset

Wrapper for _WipeDisks that handles errors.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• instance (objects.Instance) - the instance whose disks we should wipe
• disks - see _WipeDisks
• cleanup - the result returned by _CreateDisks, used for cleanup in case of error

Raises:

• errors.OpPrereqError - in case of failure

Undo the work performed by _CreateDisks.

This function is called in case of an error to undo the work of _CreateDisks.

Parameters:

• lu (LogicalUnit) - the logical unit on whose behalf we execute
• disks_created - the result returned by _CreateDisks

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
• disks (list of {objects.Disk}) - the disks to create; if not specified, all the disks of the instance are created

Returns:

information about the created disks, to be used to call _UndoCreateDisks

Raises:

• errors.OpPrereqError - in case of error

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.

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

Filters out non-vm_capable nodes from a list.

Parameters:

• lu (LogicalUnit) - the logical unit for which we check
• nodenames (list) - the list of nodes on which we should check

Returns: list

the list of vm-capable nodes

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

Wrapper around IAReqInstanceAlloc.

Parameters:

• op - The instance opcode
• disks - The computed disks
• nics - The computed nics
• beparams - The full filled beparams
• node_whitelist - List of nodes which should appear as online to the allocator (unless the node is already marked offline)

Returns:

A filled iallocator.IAReqInstanceAlloc

Computes the nics.

Parameters:

• op - The instance opcode
• cluster - Cluster configuration object
• default_ip - The default ip to assign
• cfg - An instance of the configuration object
• ec_id - Execution context ID

Returns:

The build up nics

Computes the instance disks.

Parameters:

• op - The instance opcode
• default_vg - The default_vg to assume

Returns:

The computed disks

Computes the full beparams.

Parameters:

• op - The instance opcode
• cluster - The cluster config object

Returns:

The fully filled beparams

Returns console information for an instance.

Parameters:

• cluster (objects.Cluster)
• instance (objects.Instance)

Returns: dict

Unpacks the result of change-group and node-evacuate iallocator requests.

Iallocator modes constants.IALLOCATOR_MODE_NODE_EVAC and constants.IALLOCATOR_MODE_CHG_GROUP.

Parameters:

• lu (LogicalUnit) - Logical unit instance
• alloc_result (tuple/list) - Result from iallocator
• early_release (bool) - Whether to release locks early if possible
• use_nodes (bool) - Whether to display node names instead of groups

Converts a disk size in bytes to mebibytes.

Warns and rounds up if the size isn't an even multiple of 1 MiB.

Updates the iv_name attribute of disks.

Parameters:

• disks (list of objects.Disk)

Checks for network interface conflicts with a network.

Parameters:

• check_fn (callable receiving one parameter (objects.NIC) and returning boolean) - Function checking for conflict
• action (string) - Part of error message (see code)
• lu (LogicalUnit)

Raises:

• errors.OpPrereqError - If conflicting IP addresses are found.

Returns the implemtnation for a query type.

Parameters:

• name - Query type, must be one of constants.QR_VIA_OP

In case of conflicting IP address raise error.

Parameters:

• ip (string) - IP address
• node (string) - node name

_DISK_TEMPLATE_NAME_PREFIX

Value:

{constants.DT_PLAIN: "", constants.DT_RBD: ".rbd", constants.DT_EXT: " .ext",}

_DISK_TEMPLATE_DEVICE_TYPE

Value:

{constants.DT_PLAIN: constants.LD_LV, constants.DT_FILE: constants.LD_ FILE, constants.DT_SHARED_FILE: constants.LD_FILE, constants.DT_BLOCK: constants.LD_BLOCKDEV, constants.DT_RBD: constants.LD_RBD, constants. DT_EXT: constants.LD_EXT,}

_TApplyContModsCbChanges

Type description for changes as returned by ApplyContainerMods's callbacks

Value:

ht.TMaybeListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([ht.TNonEmptyString , ht.TAny,])))

_QUERY_IMPL

Query type implementations

Value:

{constants.QR_CLUSTER: _ClusterQuery, constants.QR_INSTANCE: _Instance Query, constants.QR_NODE: _NodeQuery, constants.QR_GROUP: _GroupQuery, constants.QR_NETWORK: _NetworkQuery, constants.QR_OS: _OsQuery, const ants.QR_EXTSTORAGE: _ExtStorageQuery, constants.QR_EXPORT: _ExportQuer y,}