ganeti.client.gnt

module documentation

Job filter rule commands

Function	`AddFilter`	Add a job filter rule.
Function	`DeleteFilter`	Remove a job filter rule.
Function	`ListFilterFields`	List filter rule fields.
Function	`ListFilters`	List job filter rules and their properties.
Function	`Main`	Undocumented
Function	`ReplaceFilter`	Replaces a job filter rule with the given UUID, or creates it, if it doesn't exist already.
Function	`ShowFilter`	Show filter rule details.
Constant	`FILTER_ACTION_OPT`	Undocumented
Constant	`FILTER_PREDICATES_OPT`	Undocumented
Constant	`FILTER_PRIORITY_OPT`	Undocumented
Variable	`commands`	Undocumented
Constant	`_LIST_DEF_FIELDS`	Undocumented

def AddFilter(opts, args): ¶

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

def DeleteFilter(_, args): ¶

Remove a job filter rule.

Parameters
_	Undocumented
args:list	a list of length 1 with the UUID of the filter to remove
Returns
int	the desired exit code

def ListFilterFields(opts, args): ¶

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

def ListFilters(opts, args): ¶

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

def Main(): ¶

Undocumented

def ReplaceFilter(opts, args): ¶

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

def ShowFilter(_, args): ¶

Show filter rule details.

Parameters
_	Undocumented
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

FILTER_ACTION_OPT = ¶

Undocumented

Value

cli_option('--action',
           dest='action',
           action='store',
           default='CONTINUE',
           type='filteraction',
           help='The effect of the filter. Can be one of \'ACCEPT\', \'PAUSE\', ↵
\'REJECT\', \'CONTINUE\' and \'[RATE_LIMIT, n]\', where n is a positive integer.'↵
...

FILTER_PREDICATES_OPT = ¶

Undocumented

Value

cli_option('--predicates',
           dest='predicates',
           action='store',
           default=[],
           type='json',
           help='List of predicates in the Ganeti query language, given as a JSO↵
N list.')

FILTER_PRIORITY_OPT = ¶

Undocumented

Value

cli_option('--priority',
           dest='priority',
           action='store',
           default=0,
           type='int',
           help='Priority for filter processing')

commands = ¶

Undocumented

_LIST_DEF_FIELDS: list[str] = ¶

Undocumented

Value

['uuid', 'watermark', 'priority', 'predicates', 'action', 'reason_trail']

ganeti.client.gnt_filter

`ganeti.client.gnt_filter`