Package ganeti :: Package client :: Module gnt_filter
[hide private]
[frames] | no frames]

Module gnt_filter

source code

Job filter rule commands

Functions [hide private]
int
AddFilter(opts, args)
Add a job filter rule.
source code
int
ListFilters(opts, args)
List job filter rules and their properties.
source code
int
ListFilterFields(opts, args)
List filter rule fields.
source code
int
ReplaceFilter(opts, args)
Replaces a job filter rule with the given UUID, or creates it, if it doesn't exist already.
source code
int
ShowFilter(_, args)
Show filter rule details.
source code
int
DeleteFilter(_, args)
Remove a job filter rule.
source code
 
Main() source code
Variables [hide private]
  _LIST_DEF_FIELDS = ["uuid", "watermark", "priority", "predicat...
default list of fields for ListFilters
  FILTER_PRIORITY_OPT = cli_option("--priority", dest= "priority...
  FILTER_PREDICATES_OPT = cli_option("--predicates", dest= "pred...
  FILTER_ACTION_OPT = cli_option("--action", dest= "action", act...
  commands = {"add":(AddFilter, ARGS_NONE, [FILTER_PRIORITY_OPT,...

Imports: TO_GROUP_OPT, POWER_DELAY_OPT, VERBOSE_OPT, OPT_COMPL_ALL, OOB_TIMEOUT_OPT, IPOLICY_SPINDLE_RATIO, ARGS_ONE_INSTANCE, MAC_PREFIX_OPT, NOMODIFY_SSH_SETUP_OPT, IPOLICY_DISK_TEMPLATES, GATEWAY_OPT, VERIFY_CLUTTER_OPT, NOSSH_KEYCHECK_OPT, JobPollCbBase, SHUTDOWN_TIMEOUT_OPT, ZEROING_TIMEOUT_FIXED_OPT, ArgNode, UIDPOOL_OPT, ARGS_ONE_GROUP, ARGS_MANY_NODES, NO_REMEMBER_OPT, UsesRPC, ALLOC_POLICY_OPT, GenericListFields, FormatTable, NOVOTING_OPT, TISPECS_CLUSTER_TYPES, NOIPCHECK_OPT, ArgUnknown, NET_OPT, SPECS_CPU_COUNT_OPT, netutils, SPECS_DISK_SIZE_OPT, GenericList, SECONDARY_IP_OPT, CLEANUP_OPT, NETWORK6_OPT, NWSYNC_OPT, GenericPollJob, IDENTIFY_DEFAULTS_OPT, IPOLICY_STD_SPECS_OPT, FormatTimestamp, GenerateTable, COMMON_CREATE_OPTS, DEFAULT_IALLOCATOR_PARAMS_OPT, NORUNTIME_CHGS_OPT, ENABLED_USER_SHUTDOWN_OPT, textwrap, READD_OPT, SUBMIT_OPTS, ConfirmOperation, ssh, SubmitOrSend, RAPI_CERT_OPT, rpcerr, ArgOs, HOTPLUG_IF_POSSIBLE_OPT, ABSOLUTE_OPT, FILESTORE_DIR_OPT, ROMAN_OPT, SEP_OPT, RESERVED_LVS_OPT, USE_EXTERNAL_MIP_SCRIPT, GLOBAL_SHARED_FILEDIR_OPT, FormatPolicyInfo, MAINTAIN_NODE_HEALTH_OPT, GenericInstanceCreate, ArgChoice, shlex, TRANSPORT_COMPRESSION_OPT, DRY_RUN_OPT, CAPAB_VM_OPT, NODE_POWERED_OPT, NODE_PLACEMENT_OPT, JobExecutor, FixHvParams, ToStderr, AUTO_PROMOTE_OPT, SINGLE_NODE_OPT, ganeti, TAG_ADD_OPT, qlang, OSPARAMS_PRIVATE_OPT, ARGS_MANY_FILTERS, NIC_PARAMS_OPT, SPICE_CACERT_OPT, PrintIPolicyCommand, AUTO_REPLACE_OPT, MC_OPT, OSPARAMS_SECRET_OPT, cli_option, AskUser, CLUSTER_DOMAIN_SECRET_OPT, compat, DISK_STATE_OPT, TableColumn, errors, HVOPTS_OPT, NOMODIFY_ETCHOSTS_OPT, TitledHelpFormatter, SendJob, NEW_RAPI_CERT_OPT, CONFIRM_OPT, ARGS_NONE, ALL_OPT, NEW_NODE_CERT_OPT, HOTPLUG_OPT, CalculateOSNames, IGNORE_SIZE_OPT, ParseNicOption, PrintGenericInfo, ARGS_ONE_NODE, ArgCommand, NONAMECHECK_OPT, FAILURE_ONLY_OPT, ParseFields, ALLOW_FAILOVER_OPT, ENABLED_DISK_TEMPLATES_OPT, INSTANCE_COMMUNICATION_NETWORK_OPT, SPECS_NIC_COUNT_OPT, OS_SIZE_OPT, IGNORE_OFFLINE_OPT, SUBMIT_OPT, ARGS_ONE_FILTER, objects, ARGS_MANY_GROUPS, ADD_UIDS_OPT, JobSubmittedException, ON_PRIMARY_OPT, MASTER_NETMASK_OPT, SPICE_CERT_OPT, NEW_CLUSTER_CERT_OPT, INTERVAL_OPT, ToStdout, FormatResultError, FORCE_FILTER_OPT, OSPARAMS_OPT, logging, IPOLICY_STD_SPECS_STR, StringIO, RQL_OPT, NODE_PARAMS_OPT, ARGS_ONE_NETWORK, SPLIT_ISPECS_OPTS, RunWhileClusterStopped, BLK_OS_OPT, GLOBAL_FILEDIR_OPT, itertools, SRC_NODE_OPT, CAPAB_MASTER_OPT, SetGenericOpcodeOpts, MODIFY_ETCHOSTS_OPT, os, SPECS_MEM_SIZE_OPT, ArgHost, OS_OPT, NOSHUTDOWN_OPT, INSTANCE_POLICY_OPTS, ERROR_CODES_OPT, IGNORE_FAILURES_OPT, IGNORE_HVVERSIONS_OPT, MASTER_NETDEV_OPT, USE_REPL_NET_OPT, NODEGROUP_OPT, SRC_DIR_OPT, ArgFile, rpc, SYNC_OPT, REMOVE_UIDS_OPT, INSTANCE_COMMUNICATION_OPT, HYPERVISOR_OPT, NONPLUS1_OPT, opcodes, IGNORE_ERRORS_OPT, EARLY_RELEASE_OPT, ONLINE_INST_OPT, IGNORE_SECONDARIES_OPT, SplitNodeOption, errno, REBOOT_TYPE_OPT, IGNORE_CONSIST_OPT, ToStdoutAndLoginfo, IGNORE_IPOLICY_OPT, INSTALL_IMAGE_OPT, NODE_FORCE_JOIN_OPT, NOHDR_OPT, NEW_SPICE_CERT_OPT, ArgExtStorage, NEW_SSH_KEY_OPT, StdioJobPollReportCb, HV_STATE_OPT, NONLIVE_OPT, ARGS_ONE_OS, DISK_OPT, FORCE_FAILOVER_OPT, PRIMARY_ONLY_OPT, GetClient, SECONDARY_ONLY_OPT, REMOVE_RESERVED_IPS_OPT, NEW_PRIMARY_OPT, FORCE_VARIANT_OPT, GetOnlineNodes, NETWORK_OPT, TIMEOUT_OPT, TAG_SRC_OPT, COMPRESS_OPT, ArgGroup, NODE_LIST_OPT, ON_SECONDARY_OPT, AddTags, FILESTORE_DRIVER_OPT, FormatLogMessage, ArgInstance, IGNORE_REMOVE_FAILURES_OPT, CreateIPolicyFromOpts, MIGRATION_MODE_OPT, GATEWAY6_OPT, SPECS_DISK_COUNT_OPT, ArgJobId, REMOVE_INSTANCE_OPT, IPOLICY_BOUNDS_SPECS_STR, MAX_TRACK_OPT, PollJob, TISPECS_GROUP_TYPES, ZEROING_TIMEOUT_PER_MIB_OPT, HELPER_SHUTDOWN_TIMEOUT_OPT, DEBUG_SIMERR_OPT, STATIC_OPT, COMPRESSION_TOOLS_OPT, DISK_TEMPLATE_OPT, NONICS_OPT, OptionParser, SELECT_OS_OPT, REASON_OPT, NO_INSTALL_OPT, NEW_SECONDARY_OPT, FORCE_OPT, PRINT_JOBID_OPT, SHOWCMD_OPT, RemoveTags, ArgNetwork, DEFAULT_IALLOCATOR_OPT, OFFLINE_INST_OPT, SubmitOpCodeToDrainedQueue, NOCONFLICTSCHECK_OPT, PRIORITY_OPT, ListTags, NEW_CLUSTER_DOMAIN_SECRET_OPT, FormatParamsDictInfo, SubmitOpCode, GetNodeUUIDs, COMMON_OPTS, DRAINED_OPT, HVLIST_OPT, ParseTimespec, JobPollReportCbBase, GenericMain, pathutils, WFSYNC_OPT, DEBUG_OPT, ZERO_FREE_SPACE_OPT, PRIMARY_IP_VERSION_OPT, NODEGROUP_OPT_NAME, ArgFilter, GetNodesSshPorts, CP_SIZE_OPT, ADD_RESERVED_IPS_OPT, RUNTIME_MEM_OPT, HID_OS_OPT, SHOW_MACHINE_OPT, NOSTART_OPT, SEQUENTIAL_OPT, ALLOCATABLE_OPT, ARGS_MANY_INSTANCES, PREALLOC_WIPE_DISKS_OPT, sys, FormatQueryResult, FormatError, ENABLED_DATA_COLLECTORS_OPT, ARGS_MANY_NETWORKS, ArgSuggest, USEUNITS_OPT, IPOLICY_VCPU_RATIO, ZEROING_IMAGE_OPT, OFFLINE_OPT, EXT_PARAMS_OPT, DRBD_HELPER_OPT, ENABLED_HV_OPT, YES_DOIT_OPT, FeedbackFnJobPollReportCb, VG_NAME_OPT, DISK_PARAMS_OPT, FIELDS_OPT, GLOBAL_GLUSTER_FILEDIR_OPT, DST_NODE_OPT, RunWhileDaemonsStopped, IALLOCATOR_OPT, NEW_CONFD_HMAC_KEY_OPT, time, HELPER_STARTUP_TIMEOUT_OPT, INCLUDEDEFAULTS_OPT, STARTUP_PAUSED_OPT, DISKIDX_OPT, serializer, BACKEND_OPT, constants, utils


Function Details [hide private]

AddFilter(opts, args)

source code 

Add a job filter rule.

Parameters:
  • opts - the command line options selected by the user
  • args (list) - should be an empty list
Returns: int
the desired exit code

ListFilters(opts, args)

source code 

List job filter rules and their properties.

Parameters:
  • opts - the command line options selected by the user
  • args (list) - filters to list, or empty for all
Returns: int
the desired exit code

ListFilterFields(opts, args)

source code 

List filter rule fields.

Parameters:
  • opts - the command line options selected by the user
  • args (list) - fields to list, or empty for all
Returns: int
the desired exit code

ReplaceFilter(opts, args)

source code 

Replaces a job filter rule with the given UUID, or creates it, if it doesn't exist already.

Parameters:
  • opts - the command line options selected by the user
  • args (list) - should contain only one element, the UUID of the filter
Returns: int
the desired exit code

ShowFilter(_, args)

source code 

Show filter rule details.

Parameters:
  • args (list) - should either be an empty list, in which case we show information about all filters, or should contain a list of filter UUIDs to be queried for information
Returns: int
the desired exit code

DeleteFilter(_, args)

source code 

Remove a job filter rule.

Parameters:
  • args (list) - a list of length 1 with the UUID of the filter to remove
Returns: int
the desired exit code

Variables Details [hide private]

_LIST_DEF_FIELDS

default list of fields for ListFilters

Value:
["uuid", "watermark", "priority", "predicates", "action", "reason_trai\
l"]

FILTER_PRIORITY_OPT

Value:
cli_option("--priority", dest= "priority", action= "store", default= 0\
, type= "int", help= "Priority for filter processing")

FILTER_PREDICATES_OPT

Value:
cli_option("--predicates", dest= "predicates", action= "store", defaul\
t= [], type= "json", help= "List of predicates in the Ganeti query lan\
guage," " given as a JSON list.")

FILTER_ACTION_OPT

Value:
cli_option("--action", dest= "action", action= "store", default= "CONT\
INUE", type= "filteraction", help= "The effect of the filter. Can be o\
ne of 'ACCEPT'," " 'PAUSE', 'REJECT', 'CONTINUE' and '[RATE_LIMIT, n]'\
," " where n is a positive integer.")

commands

Value:
{"add":(AddFilter, ARGS_NONE, [FILTER_PRIORITY_OPT, FILTER_PREDICATES_\
OPT, FILTER_ACTION_OPT], "", "Adds a new filter rule"), "list":(ListFi\
lters, ARGS_MANY_FILTERS, [NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT\
], "[<filter_uuid>...]", "Lists the job filter rules. The available fi\
elds can be shown" " using the \"list-fields\" command (see the man pa\
ge for details)." " The default list is (in order): %s." % utils.Comma\
Join(_LIST_DEF_FIELDS)), "list-fields":(ListFilterFields, [ArgUnknown(\
)], [NOHDR_OPT, SEP_OPT], "[fields...]", "Lists all available fields f\
...