Module opcodes

Split an opcode class name into its components

Parameters:

• name (string) - the class name, as OpXxxYyy

Returns: array of strings

the components of the name

Convert an opcode class name to an OP_ID.

Parameters:

• name (string) - the class name, as OpXxxYyy

Returns: string

the name in the OP_XXXX_YYYY format

Helper to generate type checks for objects.

Parameters:

• obj - The object to generate type checks
• fields_types - The fields and their types as a dict

Returns:

A ht type check function

Ensures file storage is enabled if used.

Decorators:

• @ht.WithDesc("CheckFileStorage")

Builds check for disk template.

Parameters:

• accept_none (bool) - whether to accept None as a correct value

Returns: callable

Ensure a given CIDR notation type is valid.

Decorators:

• @ht.WithDesc("IPv4 network")

Ensure a given CIDR notation type is valid.

Decorators:

• @ht.WithDesc("IPv4 address")

Ensure a given CIDR notation type is valid.

Decorators:

• @ht.WithDesc("IPv6 address")

Ensure a given CIDR notation type is valid.

Decorators:

• @ht.WithDesc("IPv6 network")

Builds check for job dependencies (DEPEND_ATTR).

Parameters:

• relative (bool) - Whether to accept relative job IDs (negative)

Returns: callable

Returns list of all defined opcodes.

Does not eliminate duplicates by OP_ID.

_POutputFields

output fields for a query operation

Value:

"output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), "Select ed output fields"

_PShutdownTimeout

the shutdown timeout

Value:

"shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativ eInt, "How long to wait for instance to shut down"

_PForce

the force parameter

Value:

"force", False, ht.TBool, "Whether to force the operation"

_PInstanceName

a required instance name (for single-instance LUs)

Value:

"instance_name", ht.NoDefault, ht.TNonEmptyString, "Instance name"

_PIgnoreOfflineNodes

Whether to ignore offline nodes

Value:

"ignore_offline_nodes", False, ht.TBool, "Whether to ignore offline no des"

_PNodeName

a required node name (for single-node LUs)

Value:

"node_name", ht.NoDefault, ht.TNonEmptyString, "Node name"

_PGroupName

a required node group name (for single-group LUs)

Value:

"group_name", ht.NoDefault, ht.TNonEmptyString, "Group name"

_PMigrationMode

Migration type (live/non-live)

Value:

"mode", None, ht.TMaybe(ht.TElemOf(constants.HT_MIGRATION_MODES)), "Mi gration mode"

_PMigrationLive

Obsolete 'live' migration mode (boolean)

Value:

"live", None, ht.TMaybeBool, "Legacy setting for live migration, do no t use"

_PTagKind

Tag type

Value:

"kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES), "Tag kind "

_PTags

List of tag strings

Value:

"tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), "List of tag nam es"

_PForceVariant

Value:

"force_variant", False, ht.TBool, "Whether to force an unknown OS vari ant"

_PWaitForSync

Value:

"wait_for_sync", True, ht.TBool, "Whether to wait for the disk to sync hronize"

_PWaitForSyncFalse

Value:

"wait_for_sync", False, ht.TBool, "Whether to wait for the disk to syn chronize" " (defaults to false)"

_PIgnoreConsistency

Value:

"ignore_consistency", False, ht.TBool, "Whether to ignore disk consist ency"

_PStorageName

Value:

"name", ht.NoDefault, ht.TMaybeString, "Storage name"

_PUseLocking

Value:

"use_locking", False, ht.TBool, "Whether to use synchronization"

_PNameCheck

Value:

"name_check", True, ht.TBool, "Whether to check name"

_PNodeGroupAllocPolicy

Value:

"alloc_policy", None, ht.TMaybe(ht.TElemOf(constants.VALID_ALLOC_POLIC IES)), "Instance allocation policy"

_PGroupNodeParams

Value:

"ndparams", None, ht.TMaybeDict, "Default node parameters for group"

_PQueryWhat

Value:

"what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP), "Resource(s) to query for"

_PEarlyRelease

Value:

"early_release", False, ht.TBool, "Whether to release locks as soon as possible"

_PIpCheckDoc

Value:

"Whether to ensure instance's IP address is inactive"

_PNoRemember

Do not remember instance state changes

Value:

"no_remember", False, ht.TBool, "Do not remember the state change"

_PMigrationTargetNode

Target node for instance migration/failover

Value:

"target_node", None, ht.TMaybeString, "Target node for shared-storage instances"

_PStartupPaused

Value:

"startup_paused", False, ht.TBool, "Pause instance at startup"

_PDebugSimulateErrors

Value:

"debug_simulate_errors", False, ht.TBool, "Whether to simulate errors (useful for debugging)"

_PSkipChecks

Value:

"skip_checks", ht.EmptyList, ht.TListOf(ht.TElemOf(constants.VERIFY_OP TIONAL_CHECKS)), "Which checks to skip"

_PIgnoreErrors

Value:

"ignore_errors", ht.EmptyList, ht.TListOf(ht.TElemOf(constants.CV_ALL_ ECODES_STRINGS)), "List of error codes that should be treated as warni ngs"

_PDiskParams

Value:

"diskparams", None, ht.TMaybe(ht.TDictOf(ht.TElemOf(constants.DISK_TEM PLATES), ht.TDict)), "Disk templates' parameter defaults"

_PHvState

Value:

"hv_state", None, ht.TMaybeDict, "Set hypervisor states"

_PDiskState

Value:

"disk_state", None, ht.TMaybeDict, "Set disk states"

_POpportunisticLocking

Opportunistic locking

Value:

"opportunistic_locking", False, ht.TBool, ("Whether to employ opportun istic locking for nodes, meaning nodes" " already locked by another op code won't be considered for instance" " allocation (only when an iall ocator is used)")

_PIgnoreIpolicy

Value:

"ignore_ipolicy", False, ht.TBool, "Whether to ignore ipolicy violatio ns"

_PAllowRuntimeChgs

Value:

"allow_runtime_changes", True, ht.TBool, "Allow runtime changes (eg. m emory ballooning)"

_PNetworkName

a required network name

Value:

"network_name", ht.NoDefault, ht.TNonEmptyString, "Set network name"

_PTargetGroups

Value:

"target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), "Destinati on group names or UUIDs (defaults to \"all but current group\")"

_TestClusterOsListItem

Utility function for OpClusterSetParams

Value:

ht.TAnd(ht.TIsLength(2), ht.TItems([ht.TElemOf(constants.DDMS_VALUES), ht.TNonEmptyString,]))

_TestNicDef

Utility function for testing NIC definitions

Value:

ht.Comment("NIC parameters")(ht.TDictOf(ht.TElemOf(constants.INIC_PARA MS), ht.TMaybeString))

_TSetParamsResultItemItems

Value:

[ht.Comment("name of changed parameter")(ht.TNonEmptyString), ht.Comme nt("new value")(ht.TAny),]

_TSetParamsResult

Value:

ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)), ht.T Items(_TSetParamsResultItemItems)))

_TDiskParams

Value:

ht.Comment("Disk parameters")(ht.TDictOf(ht.TNonEmptyString, ht.TOr(ht .TNonEmptyString, ht.TInt)))

_TQueryRow

Value:

ht.TListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([ht.TElemOf(constants.RS _ALL), ht.TAny])))

_SUMMARY_PREFIX

Value:

{"CLUSTER_": "C_", "GROUP_": "G_", "NODE_": "N_", "INSTANCE_": "I_",}

_TQueryFieldDef

Value:

_GenerateObjectTypeCheck(objects.QueryFieldDefinition, {"name": ht.TNo nEmptyString, "title": ht.TNonEmptyString, "kind": ht.TElemOf(constant s.QFT_ALL), "doc": ht.TNonEmptyString,})

_PStorageType

Storage type parameter

Value:

"storage_type", ht.NoDefault, _CheckStorageType, "Storage type"

_TJobIdListItem

List of submission status and job ID as returned by SubmitManyJobs

Value:

ht.TAnd(ht.TIsLength(2), ht.TItems([ht.Comment("success")(ht.TBool), h t.Comment("Job ID if successful, error message" " otherwise")(ht.TOr(h t.TString, ht.TJobId))]))