ganeti.luxi.Client

class documentation

class Client(cl.AbstractClient):

View In Hierarchy

High-level client implementation.

This uses a backing Transport-like class on top of which it implements data serialization/deserialization.

Method __init__ Constructor for the Client class.
Method ArchiveJob Undocumented
Method AutoArchiveJobs Undocumented
Method CancelJob Undocumented
Method ChangeJobPriority Undocumented
Method DeleteFilter Undocumented
Method PickupJob Undocumented
Method Query Query for resources/items.
Method QueryClusterInfo Undocumented
Method QueryConfigValues Undocumented
Method QueryExports Undocumented
Method QueryFields Query for available fields.
Method QueryFilters Undocumented
Method QueryGroups Undocumented
Method QueryInstances Undocumented
Method QueryJobs Undocumented
Method QueryNetworks Undocumented
Method QueryNodes Undocumented
Method QueryTags Undocumented
Method ReplaceFilter Undocumented
Method SetQueueDrainFlag Undocumented
Method SetWatcherPause Undocumented
Method SubmitJob Undocumented
Method SubmitJobToDrainedQueue Undocumented
Method SubmitManyJobs Undocumented
Method WaitForJobChange Undocumented
Method WaitForJobChangeOnce Waits for changes on a job.
Instance Variable address Undocumented
Instance Variable version Undocumented
Static Method _PrepareJobId Undocumented
Method _GetAddress Returns the socket address

Inherited from AbstractClient:

Method CallMethod Send a generic request and return the response.
Method Close Close the underlying connection.
Method close Same as Close, to be used with contextlib.closing(...).
Instance Variable allow_non_master Undocumented
Instance Variable timeouts Undocumented
Instance Variable transport Undocumented
Instance Variable transport_class Undocumented
Method _CloseTransport Close the transport, ignoring errors.
Method _InitTransport (Re)initialize the transport if needed.
Method _SendMethodCall Undocumented
def __init__(self, address=None, timeouts=None, transport=Transport):
overrides ganeti.rpc.client.AbstractClient.__init__

Constructor for the Client class.

Arguments are the same as for AbstractClient.

def ArchiveJob(self, job_id):

Undocumented

def AutoArchiveJobs(self, age):

Undocumented

def CancelJob(self, job_id, kill=False):

Undocumented

def ChangeJobPriority(self, job_id, priority):

Undocumented

def DeleteFilter(self, uuid):

Undocumented

def PickupJob(self, job):

Undocumented

def Query(self, what, fields, qfilter):

Query for resources/items.

Parameters
whatOne of constants.QR_VIA_LUXI
fields:List of stringsList of requested fields
qfilter:None or listQuery filter
Returns
objects.QueryResponseUndocumented
def QueryClusterInfo(self):

Undocumented

def QueryConfigValues(self, fields):

Undocumented

def QueryExports(self, nodes, use_locking):

Undocumented

def QueryFields(self, what, fields):

Query for available fields.

Parameters
whatOne of constants.QR_VIA_LUXI
fields:None or list of stringsList of requested fields
Returns
objects.QueryFieldsResponseUndocumented
def QueryFilters(self, uuids, fields):

Undocumented

def QueryGroups(self, names, fields, use_locking):

Undocumented

def QueryInstances(self, names, fields, use_locking):

Undocumented

def QueryJobs(self, job_ids, fields):

Undocumented

def QueryNetworks(self, names, fields, use_locking):

Undocumented

def QueryNodes(self, names, fields, use_locking):

Undocumented

def QueryTags(self, kind, name):

Undocumented

def ReplaceFilter(self, uuid, priority, predicates, action, reason):

Undocumented

def SetQueueDrainFlag(self, drain_flag):

Undocumented

def SetWatcherPause(self, until):

Undocumented

def SubmitJob(self, ops):

Undocumented

def SubmitJobToDrainedQueue(self, ops):

Undocumented

def SubmitManyJobs(self, jobs):

Undocumented

def WaitForJobChange(self, job_id, fields, prev_job_info, prev_log_serial):

Undocumented

def WaitForJobChangeOnce(self, job_id, fields, prev_job_info, prev_log_serial, timeout=WFJC_TIMEOUT):

Waits for changes on a job.

Parameters
job_idJob ID
fields:listList of field names to be observed
prev_job_info:None or listPreviously received job information
prev_log_serial:None or int/longHighest log serial number previously received
timeout:int/floatTimeout in seconds (values larger than WFJC_TIMEOUT will be capped to that value)
address =

Undocumented

version =
overrides ganeti.rpc.client.AbstractClient.version

Undocumented

@staticmethod
def _PrepareJobId(request_name, job_id):

Undocumented

def _GetAddress(self):
overrides ganeti.rpc.client.AbstractClient._GetAddress

Returns the socket address