module documentation

Module containing Ganeti's command line parsing options

Class CliOption Custom option class for optparse.
Function check_bool Custom parser for yes/no options.
Function check_filteraction Custom parser for filter rule actions.
Function check_ident_key_val Custom parser for ident:key=val,key=val options.
Function check_json Custom parser for JSON arguments.
Function check_key_private_val Custom parser class for private and secret key=val,key=val options.
Function check_key_val Custom parser class for key=val,key=val options.
Function check_list Custom parser for comma-separated lists.
Function check_maybefloat Custom parser for float numbers which might be also defaults.
Function check_multilist_ident_key_val Custom parser for "ident:key=val,key=val/ident:key=val//ident:.." options.
Function check_unit OptParsers custom converter for units.
Constant ABSOLUTE_OPT Undocumented
Constant ADD_RESERVED_IPS_OPT Undocumented
Constant ADD_UIDS_OPT Undocumented
Constant ALL_OPT Undocumented
Constant ALLOC_POLICY_OPT Undocumented
Constant ALLOCATABLE_OPT Undocumented
Constant ALLOW_FAILOVER_OPT Undocumented
Constant AUTO_PROMOTE_OPT Undocumented
Constant AUTO_REPLACE_OPT Undocumented
Constant BACKEND_OPT Undocumented
Constant BLK_OS_OPT Undocumented
Constant CAPAB_MASTER_OPT Undocumented
Constant CAPAB_VM_OPT Undocumented
Constant CLEANUP_OPT Undocumented
Constant CLUSTER_DOMAIN_SECRET_OPT Undocumented
Constant COMMIT_OPT Undocumented
Constant COMMON_CREATE_OPTS Undocumented
Constant COMMON_OPTS Undocumented
Constant COMPRESS_OPT Undocumented
Constant COMPRESSION_TOOLS_OPT Undocumented
Constant CONFIRM_OPT Undocumented
Constant CP_SIZE_OPT Undocumented
Constant DEBUG_OPT Undocumented
Constant DEBUG_SIMERR_OPT Undocumented
Constant DEFAULT_IALLOCATOR_OPT Undocumented
Constant DEFAULT_IALLOCATOR_PARAMS_OPT Undocumented
Constant DISK_OPT Undocumented
Constant DISK_PARAMS_OPT Undocumented
Constant DISK_STATE_OPT Undocumented
Constant DISK_TEMPLATE_OPT Undocumented
Constant DISKIDX_OPT Undocumented
Constant DRAINED_OPT Undocumented
Constant DRBD_HELPER_OPT Undocumented
Constant DRY_RUN_OPT Undocumented
Constant DST_NODE_OPT Undocumented
Constant EARLY_RELEASE_OPT Undocumented
Constant ENABLED_DATA_COLLECTORS_OPT Undocumented
Constant ENABLED_DISK_TEMPLATES_OPT Undocumented
Constant ENABLED_HV_OPT Undocumented
Constant ENABLED_USER_SHUTDOWN_OPT Undocumented
Constant ERROR_CODES_OPT Undocumented
Constant EXT_PARAMS_OPT Undocumented
Constant FAILURE_ONLY_OPT Undocumented
Constant FIELDS_OPT Undocumented
Constant FILESTORE_DIR_OPT Undocumented
Constant FILESTORE_DRIVER_OPT Undocumented
Constant FORCE_FAILOVER_OPT Undocumented
Constant FORCE_FILTER_OPT Undocumented
Constant FORCE_OPT Undocumented
Constant FORCE_VARIANT_OPT Undocumented
Constant FORTHCOMING_OPT Undocumented
Constant GATEWAY6_OPT Undocumented
Constant GATEWAY_OPT Undocumented
Constant GLOBAL_FILEDIR_OPT Undocumented
Constant GLOBAL_GLUSTER_FILEDIR_OPT Undocumented
Constant GLOBAL_SHARED_FILEDIR_OPT Undocumented
Constant HELPER_SHUTDOWN_TIMEOUT_OPT Undocumented
Constant HELPER_STARTUP_TIMEOUT_OPT Undocumented
Constant HID_OS_OPT Undocumented
Constant HOTPLUG_IF_POSSIBLE_OPT Undocumented
Constant HOTPLUG_OPT Undocumented
Constant HV_STATE_OPT Undocumented
Constant HVLIST_OPT Undocumented
Constant HVOPTS_OPT Undocumented
Constant HYPERVISOR_OPT Undocumented
Constant IALLOCATOR_OPT Undocumented
Constant IDENTIFY_DEFAULTS_OPT Undocumented
Constant IGNORE_CONSIST_OPT Undocumented
Constant IGNORE_ERRORS_OPT Undocumented
Constant IGNORE_FAILURES_OPT Undocumented
Constant IGNORE_HVVERSIONS_OPT Undocumented
Constant IGNORE_IPOLICY_OPT Undocumented
Constant IGNORE_OFFLINE_OPT Undocumented
Constant IGNORE_REMOVE_FAILURES_OPT Undocumented
Constant IGNORE_SECONDARIES_OPT Undocumented
Constant IGNORE_SIZE_OPT Undocumented
Constant IGNORE_SOFT_ERRORS_OPT Undocumented
Constant INCLUDEDEFAULTS_OPT Undocumented
Constant INSTALL_IMAGE_OPT Undocumented
Constant INSTANCE_COMMUNICATION_NETWORK_OPT Undocumented
Constant INSTANCE_COMMUNICATION_OPT Undocumented
Constant INSTANCE_POLICY_OPTS Undocumented
Constant INTERVAL_OPT Undocumented
Constant IPOLICY_BOUNDS_SPECS_OPT Undocumented
Constant IPOLICY_BOUNDS_SPECS_STR Undocumented
Constant IPOLICY_DISK_TEMPLATES Undocumented
Constant IPOLICY_SPINDLE_RATIO Undocumented
Constant IPOLICY_STD_SPECS_OPT Undocumented
Constant IPOLICY_STD_SPECS_STR Undocumented
Constant IPOLICY_VCPU_RATIO Undocumented
Constant LONG_SLEEP_OPT Undocumented
Constant MAC_PREFIX_OPT Undocumented
Constant MAINTAIN_NODE_HEALTH_OPT Undocumented
Constant MASTER_NETDEV_OPT Undocumented
Constant MASTER_NETMASK_OPT Undocumented
Constant MAX_TRACK_OPT Undocumented
Constant MC_OPT Undocumented
Constant MIGRATION_MODE_OPT Undocumented
Constant MODIFY_ETCHOSTS_OPT Undocumented
Constant NET_OPT Undocumented
Constant NETWORK6_OPT Undocumented
Constant NETWORK_OPT Undocumented
Constant NEW_CLUSTER_CERT_OPT Undocumented
Constant NEW_CLUSTER_DOMAIN_SECRET_OPT Undocumented
Constant NEW_CONFD_HMAC_KEY_OPT Undocumented
Constant NEW_NODE_CERT_OPT Undocumented
Constant NEW_PRIMARY_OPT Undocumented
Constant NEW_RAPI_CERT_OPT Undocumented
Constant NEW_SECONDARY_OPT Undocumented
Constant NEW_SPICE_CERT_OPT Undocumented
Constant NEW_SSH_KEY_OPT Undocumented
Constant NIC_PARAMS_OPT Undocumented
Constant NO_INSTALL_OPT Undocumented
Constant NO_PREFIX Undocumented
Constant NO_REMEMBER_OPT Undocumented
Constant NOCONFLICTSCHECK_OPT Undocumented
Constant NODE_FORCE_JOIN_OPT Undocumented
Constant NODE_LIST_OPT Undocumented
Constant NODE_PARAMS_OPT Undocumented
Constant NODE_PLACEMENT_OPT Undocumented
Constant NODE_POWERED_OPT Undocumented
Constant NODEGROUP_OPT Undocumented
Constant NODEGROUP_OPT_NAME Undocumented
Constant NOHDR_OPT Undocumented
Constant NOIPCHECK_OPT Undocumented
Constant NOMODIFY_ETCHOSTS_OPT Undocumented
Constant NOMODIFY_SSH_SETUP_OPT Undocumented
Constant NONAMECHECK_OPT Undocumented
Constant NONICS_OPT Undocumented
Constant NONLIVE_OPT Undocumented
Constant NONPLUS1_OPT Undocumented
Constant NORUNTIME_CHGS_OPT Undocumented
Constant NOSHUTDOWN_OPT Undocumented
Constant NOSSH_KEYCHECK_OPT Undocumented
Constant NOSTART_OPT Undocumented
Constant NOVOTING_OPT Undocumented
Constant NWSYNC_OPT Undocumented
Constant OFFLINE_INST_OPT Undocumented
Constant OFFLINE_OPT Undocumented
Constant ON_PRIMARY_OPT Undocumented
Constant ON_SECONDARY_OPT Undocumented
Constant ONLINE_INST_OPT Undocumented
Constant OOB_TIMEOUT_OPT Undocumented
Constant OPPORTUNISTIC_OPT Undocumented
Constant OPT_COMPL_ALL Undocumented
Constant OPT_COMPL_INST_ADD_NODES Undocumented
Constant OPT_COMPL_MANY_NODES Undocumented
Constant OPT_COMPL_ONE_EXTSTORAGE Undocumented
Constant OPT_COMPL_ONE_FILTER Undocumented
Constant OPT_COMPL_ONE_IALLOCATOR Undocumented
Constant OPT_COMPL_ONE_INSTANCE Undocumented
Constant OPT_COMPL_ONE_NETWORK Undocumented
Constant OPT_COMPL_ONE_NODE Undocumented
Constant OPT_COMPL_ONE_NODEGROUP Undocumented
Constant OPT_COMPL_ONE_OS Undocumented
Constant OS_OPT Undocumented
Constant OS_SIZE_OPT Undocumented
Constant OSPARAMS_OPT Undocumented
Constant OSPARAMS_PRIVATE_OPT Undocumented
Constant OSPARAMS_SECRET_OPT Undocumented
Constant POWER_DELAY_OPT Undocumented
Constant PREALLOC_WIPE_DISKS_OPT Undocumented
Constant PRIMARY_IP_VERSION_OPT Undocumented
Constant PRIMARY_ONLY_OPT Undocumented
Constant PRINT_JOBID_OPT Undocumented
Constant PRIORITY_OPT Undocumented
Constant RAPI_CERT_OPT Undocumented
Constant READD_OPT Undocumented
Constant REASON_OPT Undocumented
Constant REBOOT_TYPE_OPT Undocumented
Constant REMOVE_INSTANCE_OPT Undocumented
Constant REMOVE_RESERVED_IPS_OPT Undocumented
Constant REMOVE_UIDS_OPT Undocumented
Constant RESERVED_LVS_OPT Undocumented
Constant ROMAN_OPT Undocumented
Constant RQL_OPT Undocumented
Constant RUNTIME_MEM_OPT Undocumented
Constant SECONDARY_IP_OPT Undocumented
Constant SECONDARY_ONLY_OPT Undocumented
Constant SELECT_OS_OPT Undocumented
Constant SEP_OPT Undocumented
Constant SEQUENTIAL_OPT Undocumented
Constant SHOW_MACHINE_OPT Undocumented
Constant SHOWCMD_OPT Undocumented
Constant SHUTDOWN_TIMEOUT_OPT Undocumented
Constant SINGLE_NODE_OPT Undocumented
Constant SPECS_CPU_COUNT_OPT Undocumented
Constant SPECS_DISK_COUNT_OPT Undocumented
Constant SPECS_DISK_SIZE_OPT Undocumented
Constant SPECS_MEM_SIZE_OPT Undocumented
Constant SPECS_NIC_COUNT_OPT Undocumented
Constant SPICE_CACERT_OPT Undocumented
Constant SPICE_CERT_OPT Undocumented
Constant SPLIT_ISPECS_OPTS Undocumented
Constant SRC_DIR_OPT Undocumented
Constant SRC_NODE_OPT Undocumented
Constant SSH_KEY_BITS_OPT Undocumented
Constant SSH_KEY_TYPE_OPT Undocumented
Constant STARTUP_PAUSED_OPT Undocumented
Constant STATIC_OPT Undocumented
Constant SUBMIT_OPT Undocumented
Constant SUBMIT_OPTS Undocumented
Constant SYNC_OPT Undocumented
Constant TAG_ADD_OPT Undocumented
Constant TAG_SRC_OPT Undocumented
Constant TIMEOUT_OPT Undocumented
Constant TO_GROUP_OPT Undocumented
Constant TRANSPORT_COMPRESSION_OPT Undocumented
Constant UIDPOOL_OPT Undocumented
Constant UN_PREFIX Undocumented
Constant USE_EXTERNAL_MIP_SCRIPT Undocumented
Constant USE_REPL_NET_OPT Undocumented
Constant USEUNITS_OPT Undocumented
Constant VERBOSE_OPT Undocumented
Constant VERIFY_CLUTTER_OPT Undocumented
Constant VG_NAME_OPT Undocumented
Constant WFSYNC_OPT Undocumented
Constant YES_DOIT_OPT Undocumented
Constant ZERO_FREE_SPACE_OPT Undocumented
Constant ZEROING_IMAGE_OPT Undocumented
Constant ZEROING_TIMEOUT_FIXED_OPT Undocumented
Constant ZEROING_TIMEOUT_PER_MIB_OPT Undocumented
Function _PriorityOptionCb Callback for processing --priority option.
Function _SplitIdentKeyVal Helper function to parse "ident:key=val,key=val" options.
Function _SplitKeyVal Convert a KeyVal string into a dict.
Function _SplitListKeyVal Undocumented
Constant _PRIONAME_TO_VALUE Undocumented
Constant _PRIORITY_NAMES Undocumented
Constant _YORNO Undocumented
def check_bool(option, opt, value):

Custom parser for yes/no options.

This will store the parsed value as either True or False.

def check_filteraction(option, opt, value):

Custom parser for filter rule actions.

Takes a string, returns an action as a Python object (list or string).

The string "RATE_LIMIT n" becomes `["RATE_LIMIT", n]`. All other strings stay as they are.

def check_ident_key_val(option, opt, value):

Custom parser for ident:key=val,key=val options.

This will store the parsed values as a tuple (ident, {key: val}). As such, multiple uses of this option via action=append is possible.

def check_json(option, opt, value):

Custom parser for JSON arguments.

Takes a string containing JSON, returns a Python object.

def check_key_private_val(option, opt, value):

Custom parser class for private and secret key=val,key=val options.

This will store the parsed values as a dict {key: val}.

def check_key_val(option, opt, value):

Custom parser class for key=val,key=val options.

This will store the parsed values as a dict {key: val}.

def check_list(option, opt, value):

Custom parser for comma-separated lists.

def check_maybefloat(option, opt, value):

Custom parser for float numbers which might be also defaults.

def check_multilist_ident_key_val(_, opt, value):

Custom parser for "ident:key=val,key=val/ident:key=val//ident:.." options.

Returns
list of dictionary[{ident: {key: val, key: val}, ident: {key: val}}, {ident:..}]
def check_unit(option, opt, value):

OptParsers custom converter for units.

ABSOLUTE_OPT =

Undocumented

Value
cli_option('--absolute',
           dest='absolute',
           action='store_true',
           default=False,
           help='Marks the grow as absolute instead of the (default) relative mo
de')
ADD_RESERVED_IPS_OPT =

Undocumented

Value
cli_option('--add-reserved-ips',
           action='store',
           default=None,
           dest='add_reserved_ips',
           help='Comma-separated list of reserved IPs to add')
ADD_UIDS_OPT =

Undocumented

Value
cli_option('--add-uids',
           default=None,
           action='store',
           dest='add_uids',
           help='A list of user-ids or user-id ranges separated by commas, to be
 added to the user-id pool')
ALL_OPT =

Undocumented

Value
cli_option('--all',
           dest='show_all',
           default=False,
           action='store_true',
           help='Show info on all instances on the cluster. This can take a long
 time to run, use wisely')
ALLOC_POLICY_OPT =

Undocumented

Value
cli_option('--alloc-policy',
           dest='alloc_policy',
           action='store',
           metavar='POLICY',
           default=None,
           help='Allocation policy for the node group')
ALLOCATABLE_OPT =

Undocumented

Value
cli_option('--allocatable',
           dest='allocatable',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Set the allocatable flag on a volume')
ALLOW_FAILOVER_OPT =

Undocumented

Value
cli_option('--allow-failover',
           dest='allow_failover',
           action='store_true',
           default=False,
           help='If migration is not possible fallback to failover')
AUTO_PROMOTE_OPT =

Undocumented

Value
cli_option('--auto-promote',
           dest='auto_promote',
           default=False,
           action='store_true',
           help='Lock all nodes and auto-promote as needed to MC status')
AUTO_REPLACE_OPT =

Undocumented

Value
cli_option('-a', '--auto',
           dest='auto',
           default=False,
           action='store_true',
           help='Automatically replace faulty disks (applies only to internally 
mirrored disk templates, e.g. %s)'%utils.CommaJoin(constants.DTS_INT_MIRROR))
BACKEND_OPT =

Undocumented

Value
cli_option('-B', '--backend-parameters',
           dest='beparams', type='keyval', default={}, help='Backend parameters'
)
BLK_OS_OPT =

Undocumented

Value
cli_option('--blacklisted',
           dest='blacklisted',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Sets the blacklisted flag on the OS')
CAPAB_MASTER_OPT =

Undocumented

Value
cli_option('--master-capable',
           dest='master_capable',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Set the master_capable flag on the node')
CAPAB_VM_OPT =

Undocumented

Value
cli_option('--vm-capable',
           dest='vm_capable',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Set the vm_capable flag on the node')
CLEANUP_OPT =

Undocumented

Value
cli_option('--cleanup',
           dest='cleanup',
           default=False,
           action='store_true',
           help='Instead of performing the migration/failover, try to recover fr
om a failed cleanup. This is safe to run even if the instance is healthy, but it
 will create extra replication traffic and  disrupt briefly the replication (lik
...
CLUSTER_DOMAIN_SECRET_OPT =

Undocumented

Value
cli_option('--cluster-domain-secret',
           dest='cluster_domain_secret',
           default=None,
           help='Load new new cluster domain secret from file')
COMMIT_OPT =

Undocumented

Value
cli_option('--commit',
           dest='commit',
           action='store_true',
           default=False,
           help='The instance is already reserved and should be committed now')
COMMON_OPTS =

Undocumented

Value
[DEBUG_OPT, REASON_OPT]
COMPRESS_OPT =

Undocumented

Value
cli_option('--compress',
           dest='compress',
           type='string',
           default=constants.IEC_NONE,
           help='The compression mode to use')
COMPRESSION_TOOLS_OPT =

Undocumented

Value
cli_option('--compression-tools',
           dest='compression_tools',
           type='string',
           default=None,
           help='Comma-separated list of compression tools which are allowed to 
be used by Ganeti in various operations')
CONFIRM_OPT =

Undocumented

Value
cli_option('--yes',
           dest='confirm',
           action='store_true',
           default=False,
           help='Do not require confirmation')
CP_SIZE_OPT =

Undocumented

Value
cli_option('-C', '--candidate-pool-size',
           default=None,
           dest='candidate_pool_size',
           type='int',
           help='Set the candidate pool size')
DEBUG_OPT =

Undocumented

Value
cli_option('-d', '--debug',
           default=0, action='count', help='Increase debugging level')
DEBUG_SIMERR_OPT =

Undocumented

Value
cli_option('--debug-simulate-errors',
           default=False,
           action='store_true',
           dest='simulate_errors',
           help='Debugging option that makes the operation treat most runtime ch
ecks as failed')
DEFAULT_IALLOCATOR_OPT =

Undocumented

Value
cli_option('-I', '--default-iallocator',
           metavar='<NAME>',
           help='Set the default instance allocator plugin',
           default=None,
           type='string',
           completion_suggest=OPT_COMPL_ONE_IALLOCATOR)
DEFAULT_IALLOCATOR_PARAMS_OPT =

Undocumented

Value
cli_option('--default-iallocator-params',
           dest='default_iallocator_params',
           help='iallocator template parameters, in the format template:option=v
alue, option=value,...',
           type='keyval',
           default=None)
DISK_OPT =

Undocumented

Value
cli_option('--disk',
           help='Disk parameters',
           default=[],
           dest='disks',
           action='append',
           type='identkeyval')
DISK_PARAMS_OPT =

Undocumented

Value
cli_option('-D', '--disk-parameters',
           dest='diskparams',
           help='Disk template parameters, in the format template:option=value,o
ption=value,...',
           type='identkeyval',
           action='append',
           default=[])
DISK_STATE_OPT =

Undocumented

Value
cli_option('--disk-state',
           default=[],
           dest='disk_state',
           action='append',
           help='Specify disk state information in the format storage_type/ident
ifier:option=value,...; note this is unused for now',
           type='identkeyval')
DISK_TEMPLATE_OPT =

Undocumented

Value
cli_option('-t', '--disk-template',
           dest='disk_template',
           help='Custom disk setup (%s)'%utils.CommaJoin(constants.DISK_TEMPLATES
),
           default=None,
           metavar='TEMPL',
           choices=list(constants.DISK_TEMPLATES))
DISKIDX_OPT =

Undocumented

Value
cli_option('--disks',
           dest='disks',
           default=None,
           help='Comma-separated list of disks indices to act on (e.g. 0,2) (opt
ional, defaults to all disks)')
DRAINED_OPT =

Undocumented

Value
cli_option('-D', '--drained',
           dest='drained',
           metavar=_YORNO,
           type='bool',
           default=None,
           help='Set the drained flag on the node (excluded from allocation oper
ations)')
DRBD_HELPER_OPT =

Undocumented

Value
cli_option('--drbd-usermode-helper',
           dest='drbd_helper',
           action='store',
           default=None,
           help='Specifies usermode helper for DRBD')
DRY_RUN_OPT =

Undocumented

Value
cli_option('--dry-run',
           default=False,
           action='store_true',
           help='Do not execute the operation, just run the check steps and veri
fy if it could be executed')
DST_NODE_OPT =

Undocumented

Value
cli_option('-n', '--target-node',
           dest='dst_node',
           help='Specifies the new node for the instance',
           metavar='NODE',
           default=None,
           completion_suggest=OPT_COMPL_ONE_NODE)
EARLY_RELEASE_OPT =

Undocumented

Value
cli_option('--early-release',
           dest='early_release',
           default=False,
           action='store_true',
           help='Release the locks on the secondary node(s) early')
ENABLED_DATA_COLLECTORS_OPT =

Undocumented

Value
cli_option('--enabled-data-collectors',
           dest='enabled_data_collectors',
           type='keyval',
           default={},
           help='Deactivate or reactivate a data collector for reporting, in the
 format collector=bool, where collector is one of %s.'%""", """.join(constants.DATA_COLLECTOR_NAMES
))
ENABLED_DISK_TEMPLATES_OPT =

Undocumented

Value
cli_option('--enabled-disk-templates',
           dest='enabled_disk_templates',
           help='Comma-separated list of disk templates',
           type='string',
           default=None)
ENABLED_HV_OPT =

Undocumented

Value
cli_option('--enabled-hypervisors',
           dest='enabled_hypervisors',
           help='Comma-separated list of hypervisors',
           type='string',
           default=None)
ENABLED_USER_SHUTDOWN_OPT =

Undocumented

Value
cli_option('--user-shutdown',
           default=None,
           dest='enabled_user_shutdown',
           help='Whether user shutdown is enabled',
           type='bool')
ERROR_CODES_OPT =

Undocumented

Value
cli_option('--error-codes',
           dest='error_codes',
           help='Enable parseable error messages',
           action='store_true',
           default=False)
EXT_PARAMS_OPT =

Undocumented

Value
cli_option('-e', '--ext-params',
           dest='ext_params',
           default={},
           type='keyval',
           help='Parameters for ExtStorage template conversions in the format: p
rovider=prvdr[,param1=val1,param2=val2,...]')
FAILURE_ONLY_OPT =

Undocumented

Value
cli_option('--failure-only',
           default=False,
           action='store_true',
           help='Hide successful results and show failures only (determined by t
he exit code)')
FIELDS_OPT =

Undocumented

Value
cli_option('-o', '--output',
           dest='output',
           action='store',
           type='string',
           metavar='FIELDS',
           help='Comma separated list of output fields')
FILESTORE_DIR_OPT =

Undocumented

Value
cli_option('--file-storage-dir',
           dest='file_storage_dir',
           help='Relative path under default cluster-wide file storage dir to st
ore file-based disks',
           default=None,
           metavar='<DIR>')
FILESTORE_DRIVER_OPT =

Undocumented

Value
cli_option('--file-driver',
           dest='file_driver',
           help='Driver to use for image files',
           default=None,
           metavar='<DRIVER>',
           choices=list(constants.FILE_DRIVER))
FORCE_FAILOVER_OPT =

Undocumented

Value
cli_option('--force-failover',
           dest='force_failover',
           action='store_true',
           default=False,
           help='Do not use migration, always use failover')
FORCE_FILTER_OPT =

Undocumented

Value
cli_option('-F', '--filter',
           dest='force_filter',
           action='store_true',
           default=False,
           help='Whether command argument should be treated as filter')
FORCE_OPT =

Undocumented

Value
cli_option('-f', '--force',
           dest='force',
           action='store_true',
           default=False,
           help='Force the operation')
FORCE_VARIANT_OPT =

Undocumented

Value
cli_option('--force-variant',
           dest='force_variant',
           action='store_true',
           default=False,
           help='Force an unknown variant')
FORTHCOMING_OPT =

Undocumented

Value
cli_option('--forthcoming',
           dest='forthcoming',
           action='store_true',
           default=False,
           help='Only reserve resources, but do not create the instance yet')
GATEWAY6_OPT =

Undocumented

Value
cli_option('--gateway6',
           action='store',
           default=None,
           dest='gateway6',
           help='IP6 address of the router (gateway)')
GATEWAY_OPT =

Undocumented

Value
cli_option('--gateway',
           action='store',
           default=None,
           dest='gateway',
           help='IP address of the router (gateway)')
GLOBAL_FILEDIR_OPT =

Undocumented

Value
cli_option('--file-storage-dir',
           dest='file_storage_dir',
           help='Specify the default directory (cluster-wide) for storing the fi
le-based disks [%s]'%pathutils.DEFAULT_FILE_STORAGE_DIR,
           metavar='DIR',
           default=None)
GLOBAL_GLUSTER_FILEDIR_OPT =

Undocumented

Value
cli_option('--gluster-storage-dir',
           dest='gluster_storage_dir',
           help='Specify the default directory (cluster-wide) for mounting Glust
er file systems [%s]'%pathutils.DEFAULT_GLUSTER_STORAGE_DIR,
           metavar='GLUSTERDIR',
           default=pathutils.DEFAULT_GLUSTER_STORAGE_DIR)
GLOBAL_SHARED_FILEDIR_OPT =

Undocumented

Value
cli_option('--shared-file-storage-dir',
           dest='shared_file_storage_dir',
           help='Specify the default directory (cluster-wide) for storing the sh
ared file-based disks [%s]'%pathutils.DEFAULT_SHARED_FILE_STORAGE_DIR,
           metavar='SHAREDDIR',
           default=None)
HELPER_SHUTDOWN_TIMEOUT_OPT =

Undocumented

Value
cli_option('--helper-shutdown-timeout',
           dest='helper_shutdown_timeout',
           action='store',
           type='int',
           help='Shutdown timeout for the helper VM')
HELPER_STARTUP_TIMEOUT_OPT =

Undocumented

Value
cli_option('--helper-startup-timeout',
           dest='helper_startup_timeout',
           action='store',
           type='int',
           help='Startup timeout for the helper VM')
HID_OS_OPT =

Undocumented

Value
cli_option('--hidden',
           dest='hidden',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Sets the hidden flag on the OS')
HOTPLUG_IF_POSSIBLE_OPT =

Undocumented

Value
cli_option('--hotplug-if-possible',
           dest='hotplug_if_possible',
           action='store_true',
           default=False,
           help='Hotplug devices in case hotplug is supported')
HOTPLUG_OPT =

Undocumented

Value
cli_option('--hotplug',
           dest='hotplug',
           action='store_true',
           default=False,
           help='Hotplug supported devices (NICs and Disks)')
HV_STATE_OPT =

Undocumented

Value
cli_option('--hypervisor-state',
           default=[],
           dest='hv_state',
           action='append',
           help='Specify hypervisor state information in the format hypervisor:o
ption=value,...; note this is unused for now',
           type='identkeyval')
HVLIST_OPT =

Undocumented

Value
cli_option('-H', '--hypervisor-parameters',
           dest='hvparams',
           help='Hypervisor and hypervisor options, in the format hypervisor:opt
ion=value,option=value,...',
           default=[],
           action='append',
           type='identkeyval')
HVOPTS_OPT =

Undocumented

Value
cli_option('-H', '--hypervisor-parameters',
           type='keyval',
           default={},
           dest='hvparams',
           help='Hypervisor parameters')
HYPERVISOR_OPT =

Undocumented

Value
cli_option('-H', '--hypervisor-parameters',
           dest='hypervisor',
           help='Hypervisor and hypervisor options, in the format hypervisor:opt
ion=value,option=value,...',
           default=None,
           type='identkeyval')
IALLOCATOR_OPT =

Undocumented

Value
cli_option('-I', '--iallocator',
           metavar='<NAME>',
           help='Select nodes for the instance automatically using the <NAME> ia
llocator plugin',
           default=None,
           type='string',
           completion_suggest=OPT_COMPL_ONE_IALLOCATOR)
IDENTIFY_DEFAULTS_OPT =

Undocumented

Value
cli_option('--identify-defaults',
           dest='identify_defaults',
           default=False,
           action='store_true',
           help='Identify which saved instance parameters are equal to the curre
nt cluster defaults and set them as such, instead of marking them as overridden'
)
IGNORE_CONSIST_OPT =

Undocumented

Value
cli_option('--ignore-consistency',
           dest='ignore_consistency',
           action='store_true',
           default=False,
           help='Ignore the consistency of the disks on the secondary. The sourc
e node must be marked offline first for this to succeed.')
IGNORE_ERRORS_OPT =

Undocumented

Value
cli_option('-I', '--ignore-errors',
           default=[],
           action='append',
           dest='ignore_errors',
           choices=list(constants.CV_ALL_ECODES_STRINGS),
           help='Error code to be ignored')
IGNORE_FAILURES_OPT =

Undocumented

Value
cli_option('--ignore-failures',
           dest='ignore_failures',
           action='store_true',
           default=False,
           help='Remove the instance from the cluster configuration even if ther
e are failures during the removal process')
IGNORE_HVVERSIONS_OPT =

Undocumented

Value
cli_option('--ignore-hvversions',
           dest='ignore_hvversions',
           action='store_true',
           default=False,
           help='Ignore incompatible hypervisor versions between source and targ
et')
IGNORE_IPOLICY_OPT =

Undocumented

Value
cli_option('--ignore-ipolicy',
           dest='ignore_ipolicy',
           action='store_true',
           default=False,
           help='Ignore instance policy violations')
IGNORE_OFFLINE_OPT =

Undocumented

Value
cli_option('--ignore-offline',
           dest='ignore_offline',
           action='store_true',
           default=False,
           help='Ignore offline nodes and do as much as possible')
IGNORE_REMOVE_FAILURES_OPT =

Undocumented

Value
cli_option('--ignore-remove-failures',
           dest='ignore_remove_failures',
           action='store_true',
           default=False,
           help='Remove the instance from the cluster configuration even if ther
e are failures during the removal process')
IGNORE_SECONDARIES_OPT =

Undocumented

Value
cli_option('--ignore-secondaries',
           dest='ignore_secondaries',
           default=False,
           action='store_true',
           help='Ignore errors from secondaries')
IGNORE_SIZE_OPT =

Undocumented

Value
cli_option('--ignore-size',
           dest='ignore_size',
           default=False,
           action='store_true',
           help='Ignore current recorded size (useful for forcing activation whe
n the recorded size is wrong)')
IGNORE_SOFT_ERRORS_OPT =

Undocumented

Value
cli_option('--ignore-soft-errors',
           dest='ignore_soft_errors',
           action='store_true',
           default=False,
           help='Tell htools to ignore any soft errors like N+1 violations')
INCLUDEDEFAULTS_OPT =

Undocumented

Value
cli_option('--include-defaults',
           dest='include_defaults',
           default=False,
           action='store_true',
           help='Include default values')
INSTALL_IMAGE_OPT =

Undocumented

Value
cli_option('--install-image',
           dest='install_image',
           action='store',
           type='string',
           default=None,
           help='The OS image to use for running the OS scripts safely')
INSTANCE_COMMUNICATION_NETWORK_OPT =

Undocumented

Value
cli_option('--instance-communication-network',
           dest='instance_communication_network',
           type='string',
           help='Set the network name for instance communication')
INSTANCE_COMMUNICATION_OPT =

Undocumented

Value
cli_option('-c', '--communication',
           dest='instance_communication',
           help=constants.INSTANCE_COMMUNICATION_DOC,
           type='bool')
INTERVAL_OPT =

Undocumented

Value
cli_option('--interval',
           dest='interval',
           type='int',
           default=None,
           help='Number of seconds between repetions of the command')
IPOLICY_BOUNDS_SPECS_OPT =

Undocumented

Value
cli_option(IPOLICY_BOUNDS_SPECS_STR,
           dest='ipolicy_bounds_specs',
           type='multilistidentkeyval',
           default=None,
           help='Complete instance specs limits')
IPOLICY_BOUNDS_SPECS_STR: str =

Undocumented

Value
'--ipolicy-bounds-specs'
IPOLICY_DISK_TEMPLATES =

Undocumented

Value
cli_option('--ipolicy-disk-templates',
           dest='ipolicy_disk_templates',
           type='list',
           default=None,
           help='Comma-separated list of enabled disk templates')
IPOLICY_SPINDLE_RATIO =

Undocumented

Value
cli_option('--ipolicy-spindle-ratio',
           dest='ipolicy_spindle_ratio',
           type='maybefloat',
           default=None,
           help='The maximum allowed instances to spindle ratio')
IPOLICY_STD_SPECS_OPT =

Undocumented

Value
cli_option(IPOLICY_STD_SPECS_STR,
           dest='ipolicy_std_specs',
           type='keyval',
           default=None,
           help='Complete standard instance specs')
IPOLICY_STD_SPECS_STR: str =

Undocumented

Value
'--ipolicy-std-specs'
IPOLICY_VCPU_RATIO =

Undocumented

Value
cli_option('--ipolicy-vcpu-ratio',
           dest='ipolicy_vcpu_ratio',
           type='maybefloat',
           default=None,
           help='The maximum allowed vcpu-to-cpu ratio')
LONG_SLEEP_OPT =

Undocumented

Value
cli_option('--long-sleep',
           default=False,
           dest='long_sleep',
           help='Allow long shutdowns when backing up instances',
           action='store_true')
MAC_PREFIX_OPT =

Undocumented

Value
cli_option('-m', '--mac-prefix',
           dest='mac_prefix',
           help='Specify the mac prefix for the instance IP addresses, in the fo
rmat XX:XX:XX',
           metavar='PREFIX',
           default=None)
MAINTAIN_NODE_HEALTH_OPT =

Undocumented

Value
cli_option('--maintain-node-health',
           dest='maintain_node_health',
           metavar=_YORNO,
           default=None,
           type='bool',
           help='Configure the cluster to automatically maintain node health, by
 shutting down unknown instances, shutting down unknown DRBD devices, etc.')
MASTER_NETDEV_OPT =

Undocumented

Value
cli_option('--master-netdev',
           dest='master_netdev',
           help='Specify the node interface (cluster-wide) on which the master I
P address will be added (cluster init default: %s)'%constants.DEFAULT_BRIDGE,
           metavar='NETDEV',
           default=None)
MASTER_NETMASK_OPT =

Undocumented

Value
cli_option('--master-netmask',
           dest='master_netmask',
           help='Specify the netmask of the master IP',
           metavar='NETMASK',
           default=None)
MAX_TRACK_OPT =

Undocumented

Value
cli_option('--max-tracked-jobs',
           dest='max_tracked_jobs',
           type='int',
           help='Set the maximal number of jobs to be tracked simultaneously for
 scheduling')
MC_OPT =

Undocumented

Value
cli_option('-C', '--master-candidate',
           dest='master_candidate',
           type='bool',
           default=None,
           metavar=_YORNO,
           help='Set the master_candidate flag on the node')
MIGRATION_MODE_OPT =

Undocumented

Value
cli_option('--migration-mode',
           dest='migration_mode',
           default=None,
           choices=list(constants.HT_MIGRATION_MODES),
           help='Override default migration mode (choose either live or non-live'
)
MODIFY_ETCHOSTS_OPT =

Undocumented

Value
cli_option('--modify-etc-hosts',
           dest='modify_etc_hosts',
           metavar=_YORNO,
           default=None,
           type='bool',
           help='Defines whether the cluster should autonomously modify and keep
 in sync the /etc/hosts file of the nodes')
NET_OPT =

Undocumented

Value
cli_option('--net',
           help='NIC parameters',
           default=[],
           dest='nics',
           action='append',
           type='identkeyval')
NETWORK6_OPT =

Undocumented

Value
cli_option('--network6',
           action='store',
           default=None,
           dest='network6',
           help='IP network in CIDR notation')
NETWORK_OPT =

Undocumented

Value
cli_option('--network',
           action='store',
           default=None,
           dest='network',
           help='IP network in CIDR notation')
NEW_CLUSTER_CERT_OPT =

Undocumented

Value
cli_option('--new-cluster-certificate',
           dest='new_cluster_cert',
           default=False,
           action='store_true',
           help='Generate a new cluster certificate')
NEW_CLUSTER_DOMAIN_SECRET_OPT =

Undocumented

Value
cli_option('--new-cluster-domain-secret',
           dest='new_cluster_domain_secret',
           default=False,
           action='store_true',
           help='Create a new cluster domain secret')
NEW_CONFD_HMAC_KEY_OPT =

Undocumented

Value
cli_option('--new-confd-hmac-key',
           dest='new_confd_hmac_key',
           default=False,
           action='store_true',
           help='Create a new HMAC key for %s'%constants.CONFD)
NEW_NODE_CERT_OPT =

Undocumented

Value
cli_option('--new-node-certificates',
           dest='new_node_cert',
           default=False,
           action='store_true',
           help='Generate new node certificates (for all nodes)')
NEW_PRIMARY_OPT =

Undocumented

Value
cli_option('--new-primary',
           dest='new_primary_node',
           help='Specifies the new primary node',
           metavar='<node>',
           default=None,
           completion_suggest=OPT_COMPL_ONE_NODE)
NEW_RAPI_CERT_OPT =

Undocumented

Value
cli_option('--new-rapi-certificate',
           dest='new_rapi_cert',
           default=None,
           action='store_true',
           help='Generate a new self-signed RAPI certificate')
NEW_SECONDARY_OPT =

Undocumented

Value
cli_option('-n', '--new-secondary',
           dest='dst_node',
           help='Specifies the new secondary node',
           metavar='NODE',
           default=None,
           completion_suggest=OPT_COMPL_ONE_NODE)
NEW_SPICE_CERT_OPT =

Undocumented

Value
cli_option('--new-spice-certificate',
           dest='new_spice_cert',
           default=None,
           action='store_true',
           help='Generate a new self-signed SPICE certificate')
NEW_SSH_KEY_OPT =

Undocumented

Value
cli_option('--new-ssh-keys',
           dest='new_ssh_keys',
           default=False,
           action='store_true',
           help='Generate new node SSH keys (for all nodes)')
NIC_PARAMS_OPT =

Undocumented

Value
cli_option('-N', '--nic-parameters',
           dest='nicparams', type='keyval', default={}, help='NIC parameters')
NO_INSTALL_OPT =

Undocumented

Value
cli_option('--no-install',
           dest='no_install',
           action='store_true',
           default=False,
           help='Do not install the OS (will enable no-start)')
NO_PREFIX: str =

Undocumented

Value
'no_'
NO_REMEMBER_OPT =

Undocumented

Value
cli_option('--no-remember',
           dest='no_remember',
           action='store_true',
           default=False,
           help='Perform but do not record the change in the configuration')
NOCONFLICTSCHECK_OPT =

Undocumented

Value
cli_option('--no-conflicts-check',
           dest='conflicts_check',
           default=True,
           action='store_false',
           help='Don\'t check for conflicting IPs')
NODE_FORCE_JOIN_OPT =

Undocumented

Value
cli_option('--force-join',
           dest='force_join',
           default=False,
           action='store_true',
           help='Force the joining of a node')
NODE_LIST_OPT =

Undocumented

Value
cli_option('-n', '--node',
           dest='nodes',
           default=[],
           action='append',
           metavar='<node>',
           help='Use only this node (can be used multiple times, if not given de
faults to all nodes)',
...
NODE_PARAMS_OPT =

Undocumented

Value
cli_option('--node-parameters',
           dest='ndparams', type='keyval', default=None, help='Node parameters')
NODE_PLACEMENT_OPT =

Undocumented

Value
cli_option('-n', '--node',
           dest='node',
           help='Target node and optional secondary node',
           metavar='<pnode>[:<snode>]',
           completion_suggest=OPT_COMPL_INST_ADD_NODES)
NODE_POWERED_OPT =

Undocumented

Value
cli_option('--node-powered',
           default=None,
           type='bool',
           metavar=_YORNO,
           dest='node_powered',
           help='Specify if the SoR for node is powered')
NODEGROUP_OPT =

Undocumented

Value
cli_option('-g', NODEGROUP_OPT_NAME,
           dest='nodegroup',
           help='Node group (name or uuid)',
           metavar='<nodegroup>',
           default=None,
           type='string',
           completion_suggest=OPT_COMPL_ONE_NODEGROUP)
NODEGROUP_OPT_NAME: str =

Undocumented

Value
'--node-group'
NOHDR_OPT =

Undocumented

Value
cli_option('--no-headers',
           default=False,
           action='store_true',
           dest='no_headers',
           help='Don\'t display column headers')
NOIPCHECK_OPT =

Undocumented

Value
cli_option('--no-ip-check',
           dest='ip_check',
           default=True,
           action='store_false',
           help='Don\'t check that the instance\'s IP is alive')
NOMODIFY_ETCHOSTS_OPT =

Undocumented

Value
cli_option('--no-etc-hosts',
           dest='modify_etc_hosts',
           help='Don\'t modify %s'%pathutils.ETC_HOSTS,
           action='store_false',
           default=True)
NOMODIFY_SSH_SETUP_OPT =

Undocumented

Value
cli_option('--no-ssh-init',
           dest='modify_ssh_setup',
           help='Don\'t initialize SSH keys',
           action='store_false',
           default=True)
NONAMECHECK_OPT =

Undocumented

Value
cli_option('--no-name-check',
           dest='name_check',
           default=True,
           action='store_false',
           help='Don\'t check that the instance\'s name is resolvable')
NONICS_OPT =

Undocumented

Value
cli_option('--no-nics',
           default=False,
           action='store_true',
           help='Do not create any network cards for the instance')
NONLIVE_OPT =

Undocumented

Value
cli_option('--non-live',
           dest='live',
           default=True,
           action='store_false',
           help='Do a non-live migration (this usually means freeze the instance
, save the state, transfer and only then resume running on the secondary node)')
NONPLUS1_OPT =

Undocumented

Value
cli_option('--no-nplus1-mem',
           dest='skip_nplusone_mem',
           help='Skip N+1 memory redundancy tests',
           action='store_true',
           default=False)
NORUNTIME_CHGS_OPT =

Undocumented

Value
cli_option('--no-runtime-changes',
           dest='allow_runtime_chgs',
           default=True,
           action='store_false',
           help='Don\'t allow runtime changes')
NOSHUTDOWN_OPT =

Undocumented

Value
cli_option('--noshutdown',
           dest='shutdown',
           action='store_false',
           default=True,
           help='Don\'t shutdown the instance (unsafe)')
NOSSH_KEYCHECK_OPT =

Undocumented

Value
cli_option('--no-ssh-key-check',
           dest='ssh_key_check',
           default=True,
           action='store_false',
           help='Disable SSH key fingerprint checking')
NOSTART_OPT =

Undocumented

Value
cli_option('--no-start',
           dest='start',
           default=True,
           action='store_false',
           help='Don\'t start the instance after creation')
NOVOTING_OPT =

Undocumented

Value
cli_option('--no-voting',
           dest='no_voting',
           help='Skip node agreement check (dangerous)',
           action='store_true',
           default=False)
NWSYNC_OPT =

Undocumented

Value
cli_option('--no-wait-for-sync',
           dest='wait_for_sync',
           default=True,
           action='store_false',
           help='Don\'t wait for sync (DANGEROUS!)')
OFFLINE_INST_OPT =

Undocumented

Value
cli_option('--offline',
           dest='offline_inst',
           action='store_true',
           default=False,
           help='Disable down instance')
OFFLINE_OPT =

Undocumented

Value
cli_option('-O', '--offline',
           dest='offline',
           metavar=_YORNO,
           type='bool',
           default=None,
           help='Set the offline flag on the node (cluster does not communicate 
with offline nodes)')
ON_PRIMARY_OPT =

Undocumented

Value
cli_option('-p', '--on-primary',
           dest='on_primary',
           default=False,
           action='store_true',
           help='Replace the disk(s) on the primary node (applies only to intern
ally mirrored disk templates, e.g. %s)'%utils.CommaJoin(constants.DTS_INT_MIRROR
))
ON_SECONDARY_OPT =

Undocumented

Value
cli_option('-s', '--on-secondary',
           dest='on_secondary',
           default=False,
           action='store_true',
           help='Replace the disk(s) on the secondary node (applies only to inte
rnally mirrored disk templates, e.g. %s)'%utils.CommaJoin(constants.DTS_INT_MIRROR
))
ONLINE_INST_OPT =

Undocumented

Value
cli_option('--online',
           dest='online_inst',
           action='store_true',
           default=False,
           help='Enable offline instance')
OOB_TIMEOUT_OPT =

Undocumented

Value
cli_option('--oob-timeout',
           dest='oob_timeout',
           type='int',
           default=constants.OOB_TIMEOUT,
           help='Maximum time to wait for out-of-band helper')
OPPORTUNISTIC_OPT =

Undocumented

Value
cli_option('--opportunistic-locking',
           dest='opportunistic_locking',
           action='store_true',
           default=False,
           help='Opportunistically acquire locks')
OPT_COMPL_INST_ADD_NODES =

Undocumented

OPT_COMPL_MANY_NODES =

Undocumented

OPT_COMPL_ONE_EXTSTORAGE =

Undocumented

OPT_COMPL_ONE_FILTER =

Undocumented

OPT_COMPL_ONE_IALLOCATOR =

Undocumented

OPT_COMPL_ONE_INSTANCE =

Undocumented

OPT_COMPL_ONE_NETWORK =

Undocumented

OPT_COMPL_ONE_NODE =

Undocumented

OPT_COMPL_ONE_NODEGROUP =

Undocumented

OPT_COMPL_ONE_OS =

Undocumented

OS_OPT =

Undocumented

Value
cli_option('-o', '--os-type',
           dest='os', help='What OS to run', metavar='<os>', completion_suggest=OPT_COMPL_ONE_OS
)
OS_SIZE_OPT =

Undocumented

Value
cli_option('-s', '--os-size',
           dest='sd_size',
           help='Enforces a single-disk configuration using the given disk size,
 in MiB unless a suffix is used',
           default=None,
           type='unit',
           metavar='<size>')
OSPARAMS_OPT =

Undocumented

Value
cli_option('-O', '--os-parameters',
           dest='osparams', type='keyval', default={}, help='OS parameters')
OSPARAMS_PRIVATE_OPT =

Undocumented

Value
cli_option('--os-parameters-private',
           dest='osparams_private',
           type='keyprivateval',
           default=serializer.PrivateDict(),
           help='Private OS parameters (won\'t be logged)')
OSPARAMS_SECRET_OPT =

Undocumented

Value
cli_option('--os-parameters-secret',
           dest='osparams_secret',
           type='keyprivateval',
           default=serializer.PrivateDict(),
           help='Secret OS parameters (won\'t be logged or saved; you must suppl
y these for every operation.)')
POWER_DELAY_OPT =

Undocumented

Value
cli_option('--power-delay',
           dest='power_delay',
           type='float',
           default=constants.OOB_POWER_DELAY,
           help='Time in seconds to wait between power-ons')
PREALLOC_WIPE_DISKS_OPT =

Undocumented

Value
cli_option('--prealloc-wipe-disks',
           default=None,
           type='bool',
           metavar=_YORNO,
           dest='prealloc_wipe_disks',
           help='Wipe disks prior to instance creation')
PRIMARY_IP_VERSION_OPT =

Undocumented

Value
cli_option('--primary-ip-version',
           default=constants.IP4_VERSION,
           action='store',
           dest='primary_ip_version',
           metavar='%d|%d'%(constants.IP4_VERSION, constants.IP6_VERSION),
           help='Cluster-wide IP version for primary IP')
PRIMARY_ONLY_OPT =

Undocumented

Value
cli_option('-p', '--primary-only',
           default=False,
           action='store_true',
           help='Evacuate primary instances only')
PRINT_JOBID_OPT =

Undocumented

Value
cli_option('--print-jobid',
           dest='print_jobid',
           default=False,
           action='store_true',
           help='Additionally print the job as first line on stdout (for scripti
ng).')
PRIORITY_OPT =

Undocumented

Value
cli_option('--priority',
           default=None,
           dest='priority',
           metavar="""|""".join((name for name, _ in _PRIORITY_NAMES)),
           choices=list(_PRIONAME_TO_VALUE),
           action='callback',
           type='choice',
...
RAPI_CERT_OPT =

Undocumented

Value
cli_option('--rapi-certificate',
           dest='rapi_cert',
           default=None,
           help='File containing new RAPI certificate')
READD_OPT =

Undocumented

Value
cli_option('--readd',
           dest='readd',
           default=False,
           action='store_true',
           help='Readd old node after replacing it')
REASON_OPT =

Undocumented

Value
cli_option('--reason',
           default=[], help='The reason for executing the command')
REBOOT_TYPE_OPT =

Undocumented

Value
cli_option('-t', '--type',
           dest='reboot_type',
           help='Type of reboot: soft/hard/full',
           default=constants.INSTANCE_REBOOT_HARD,
           metavar='<REBOOT>',
           choices=list(constants.REBOOT_TYPES))
REMOVE_INSTANCE_OPT =

Undocumented

Value
cli_option('--remove-instance',
           dest='remove_instance',
           action='store_true',
           default=False,
           help='Remove the instance from the cluster')
REMOVE_RESERVED_IPS_OPT =

Undocumented

Value
cli_option('--remove-reserved-ips',
           action='store',
           default=None,
           dest='remove_reserved_ips',
           help='Comma-delimited list of reserved IPs to remove')
REMOVE_UIDS_OPT =

Undocumented

Value
cli_option('--remove-uids',
           default=None,
           action='store',
           dest='remove_uids',
           help='A list of user-ids or user-id ranges separated by commas, to be
 removed from the user-id pool')
RESERVED_LVS_OPT =

Undocumented

Value
cli_option('--reserved-lvs',
           default=None,
           action='store',
           dest='reserved_lvs',
           help='A comma-separated list of reserved logical volumes names, that 
will be ignored by cluster verify')
ROMAN_OPT =

Undocumented

Value
cli_option('--roman',
           dest='roman_integers',
           default=False,
           action='store_true',
           help='Use roman numbers for positive integers')
RQL_OPT =

Undocumented

Value
cli_option('--max-running-jobs',
           dest='max_running_jobs',
           type='int',
           help='Set the maximal number of jobs to run simultaneously')
RUNTIME_MEM_OPT =

Undocumented

Value
cli_option('-m', '--runtime-memory',
           dest='runtime_mem',
           help='Sets the instance\'s runtime memory, ballooning it up or down t
o the new value',
           default=None,
           type='unit',
           metavar='<size>')
SECONDARY_IP_OPT =

Undocumented

Value
cli_option('-s', '--secondary-ip',
           dest='secondary_ip',
           help='Specify the secondary ip for the node',
           metavar='ADDRESS',
           default=None)
SECONDARY_ONLY_OPT =

Undocumented

Value
cli_option('-s', '--secondary-only',
           default=False,
           action='store_true',
           help='Evacuate secondary instances only (applies only to internally m
irrored disk templates, e.g. %s)'%utils.CommaJoin(constants.DTS_INT_MIRROR))
SELECT_OS_OPT =

Undocumented

Value
cli_option('--select-os',
           dest='select_os',
           action='store_true',
           default=False,
           help='Interactive OS reinstall, lists available OS templates for sele
ction')
SEP_OPT =

Undocumented

Value
cli_option('--separator',
           default=None,
           action='store',
           dest='separator',
           help='Separator between output fields (defaults to one space)')
SEQUENTIAL_OPT =

Undocumented

Value
cli_option('--sequential',
           dest='sequential',
           default=False,
           action='store_true',
           help='Execute all resulting jobs sequentially')
SHOW_MACHINE_OPT =

Undocumented

Value
cli_option('-M', '--show-machine-names',
           default=False,
           action='store_true',
           help='Show machine name for every line in output')
SHOWCMD_OPT =

Undocumented

Value
cli_option('--show-cmd',
           dest='show_command',
           action='store_true',
           default=False,
           help='Show command instead of executing it')
SHUTDOWN_TIMEOUT_OPT =

Undocumented

Value
cli_option('--shutdown-timeout',
           dest='shutdown_timeout',
           type='int',
           default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
           help='Maximum time (in minutes) to wait for instance shutdown')
SINGLE_NODE_OPT =

Undocumented

Value
cli_option('-n', '--node',
           dest='node',
           help='Target node',
           metavar='<node>',
           completion_suggest=OPT_COMPL_ONE_NODE)
SPECS_CPU_COUNT_OPT =

Undocumented

Value
cli_option('--specs-cpu-count',
           dest='ispecs_cpu_count',
           type='keyval',
           default={},
           help='CPU count specs: list of key=value, where key is one of min, ma
x, std')
SPECS_DISK_COUNT_OPT =

Undocumented

Value
cli_option('--specs-disk-count',
           dest='ispecs_disk_count',
           type='keyval',
           default={},
           help='Disk count specs: list of key=value, where key is one of min, m
ax, std')
SPECS_DISK_SIZE_OPT =

Undocumented

Value
cli_option('--specs-disk-size',
           dest='ispecs_disk_size',
           type='keyval',
           default={},
           help='Disk size specs: list of key=value, where key is one of min, ma
x, std (in MB or using a unit)')
SPECS_MEM_SIZE_OPT =

Undocumented

Value
cli_option('--specs-mem-size',
           dest='ispecs_mem_size',
           type='keyval',
           default={},
           help='Memory size specs: list of key=value, where key is one of min, 
max, std (in MB or using a unit)')
SPECS_NIC_COUNT_OPT =

Undocumented

Value
cli_option('--specs-nic-count',
           dest='ispecs_nic_count',
           type='keyval',
           default={},
           help='NIC count specs: list of key=value, where key is one of min, ma
x, std')
SPICE_CACERT_OPT =

Undocumented

Value
cli_option('--spice-ca-certificate',
           dest='spice_cacert',
           default=None,
           help='File containing the certificate of the CA which signed the SPIC
E certificate')
SPICE_CERT_OPT =

Undocumented

Value
cli_option('--spice-certificate',
           dest='spice_cert',
           default=None,
           help='File containing new SPICE certificate')
SRC_DIR_OPT =

Undocumented

Value
cli_option('--src-dir',
           dest='src_dir', help='Source directory', metavar='<dir>')
SRC_NODE_OPT =

Undocumented

Value
cli_option('--src-node',
           dest='src_node',
           help='Source node',
           metavar='<node>',
           completion_suggest=OPT_COMPL_ONE_NODE)
SSH_KEY_BITS_OPT =

Undocumented

Value
cli_option('--ssh-key-bits',
           default=None,
           type='int',
           dest='ssh_key_bits',
           help='Length of SSH keys generated by Ganeti, in bits')
SSH_KEY_TYPE_OPT =

Undocumented

Value
cli_option('--ssh-key-type',
           default=None,
           choices=list(constants.SSHK_ALL),
           dest='ssh_key_type',
           help='Type of SSH key deployed by Ganeti for cluster actions')
STARTUP_PAUSED_OPT =

Undocumented

Value
cli_option('--paused',
           dest='startup_paused',
           action='store_true',
           default=False,
           help='Pause instance at startup')
STATIC_OPT =

Undocumented

Value
cli_option('-s', '--static',
           dest='static',
           action='store_true',
           default=False,
           help='Only show configuration data, not runtime data')
SUBMIT_OPT =

Undocumented

Value
cli_option('--submit',
           dest='submit_only',
           default=False,
           action='store_true',
           help='Submit the job and return the job ID, but don\'t wait for the j
ob to finish')
SUBMIT_OPTS =

Undocumented

Value
[SUBMIT_OPT, PRINT_JOBID_OPT]
SYNC_OPT =

Undocumented

Value
cli_option('--sync',
           dest='do_locking',
           default=False,
           action='store_true',
           help='Grab locks while doing the queries in order to ensure more cons
istent results')
TAG_ADD_OPT =

Undocumented

Value
cli_option('--tags',
           dest='tags',
           default=None,
           help='Comma-separated list of instance tags')
TAG_SRC_OPT =

Undocumented

Value
cli_option('--from',
           dest='tags_source', default=None, help='File with tag names')
TIMEOUT_OPT =

Undocumented

Value
cli_option('--timeout',
           dest='timeout',
           type='int',
           default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
           help='Maximum time (in minutes) to wait')
TO_GROUP_OPT =

Undocumented

Value
cli_option('--to',
           dest='to',
           metavar='<group>',
           help='Destination node group (name or uuid)',
           default=None,
           action='append',
           completion_suggest=OPT_COMPL_ONE_NODEGROUP)
TRANSPORT_COMPRESSION_OPT =

Undocumented

Value
cli_option('--transport-compression',
           dest='transport_compression',
           type='string',
           default=constants.IEC_NONE,
           help='The compression mode to use during transport')
UIDPOOL_OPT =

Undocumented

Value
cli_option('--uid-pool',
           default=None,
           action='store',
           dest='uid_pool',
           help='A list of user-ids or user-id ranges separated by commas')
UN_PREFIX: str =

Undocumented

Value
'-'
USE_EXTERNAL_MIP_SCRIPT =

Undocumented

Value
cli_option('--use-external-mip-script',
           dest='use_external_mip_script',
           help='Specify whether to run a user-provided script for the master IP
 address turnup and turndown operations',
           type='bool',
           metavar=_YORNO,
           default=None)
USE_REPL_NET_OPT =

Undocumented

Value
cli_option('--use-replication-network',
           dest='use_replication_network',
           help='Whether to use the replication network for talking to the nodes'
,
           action='store_true',
           default=False)
USEUNITS_OPT =

Undocumented

Value
cli_option('--units',
           default=None,
           dest='units',
           choices=('h', 'm', 'g', 't'),
           help='Specify units for output (one of h/m/g/t)')
VERBOSE_OPT =

Undocumented

Value
cli_option('-v', '--verbose',
           default=False,
           action='store_true',
           help='Increase the verbosity of the operation')
VERIFY_CLUTTER_OPT =

Undocumented

Value
cli_option('--verify-ssh-clutter',
           default=False,
           dest='verify_clutter',
           help='Verify that Ganeti did not clutter up the \'authorized_keys\' f
ile',
           action='store_true')
VG_NAME_OPT =

Undocumented

Value
cli_option('--vg-name',
           dest='vg_name',
           help='Enables LVM and specifies the volume group name (cluster-wide) 
for disk allocation [%s]'%constants.DEFAULT_VG,
           metavar='VG',
           default=None)
WFSYNC_OPT =

Undocumented

Value
cli_option('--wait-for-sync',
           dest='wait_for_sync',
           default=False,
           action='store_true',
           help='Wait for disks to sync')
YES_DOIT_OPT =

Undocumented

Value
cli_option('--yes-do-it', '--ya-rly',
           dest='yes_do_it', help='Destroy cluster', action='store_true')
ZERO_FREE_SPACE_OPT =

Undocumented

Value
cli_option('--zero-free-space',
           dest='zero_free_space',
           action='store_true',
           default=False,
           help='Whether to zero the free space on the disks of the instance pri
or to the export')
ZEROING_IMAGE_OPT =

Undocumented

Value
cli_option('--zeroing-image',
           dest='zeroing_image',
           action='store',
           default=None,
           help='The OS image to use to zero instance disks')
ZEROING_TIMEOUT_FIXED_OPT =

Undocumented

Value
cli_option('--zeroing-timeout-fixed',
           dest='zeroing_timeout_fixed',
           action='store',
           type='int',
           help='The fixed amount of time to wait before assuming that the zeroi
ng failed')
ZEROING_TIMEOUT_PER_MIB_OPT =

Undocumented

Value
cli_option('--zeroing-timeout-per-mib',
           dest='zeroing_timeout_per_mib',
           action='store',
           type='float',
           help='The amount of time to wait per MiB of data to zero, in addition
 to the fixed timeout')
def _PriorityOptionCb(option, _, value, parser):

Callback for processing --priority option.

def _SplitIdentKeyVal(opt, value, parse_prefixes):

Helper function to parse "ident:key=val,key=val" options.

Parameters
opt:stringoption name, used in error messages
value:stringexpected to be in the format "ident:key=val,key=val,..."
parse_prefixes:boolwhether to handle prefixes specially (see _SplitKeyVal)
Returns
tuple(ident, {key=val, key=val})
Raises
errors.ParameterErrorin case of duplicates or other parsing errors
def _SplitKeyVal(opt, data, parse_prefixes):

Convert a KeyVal string into a dict.

This function will convert a key=val[,...] string into a dict. Empty values will be converted specially: keys which have the prefix 'no_' will have the value=False and the prefix stripped, keys with the prefix "-" will have value=None and the prefix stripped, and the others will have value=True.

Parameters
opt:stringa string holding the option name for which we process the data, used in building error messages
data:stringa string of the format key=val,key=val,...
parse_prefixes:boolwhether to handle prefixes specially
Returns
dict{key=val, key=val}
Raises
errors.ParameterErrorif there are duplicate keys
def _SplitListKeyVal(opt, value):

Undocumented

_PRIONAME_TO_VALUE =

Undocumented

Value
dict(_PRIORITY_NAMES)
_PRIORITY_NAMES =

Undocumented

Value
[('low', constants.OP_PRIO_LOW),
 ('normal', constants.OP_PRIO_NORMAL),
 ('high', constants.OP_PRIO_HIGH)]
_YORNO: str =

Undocumented

Value
'yes|no'