PilotManagerClient

Module that contains client access to the Pilots handler.

class DIRAC.WorkloadManagementSystem.Client.PilotManagerClient.PilotManagerClient(url=None, **kwargs)

Bases: Client

PilotManagerClient sets url for the PilotManagerHandler.

__init__(url=None, **kwargs)

Sets URL for PilotManager handler

Parameters:

  • self – self reference

  • url – url of the PilotManagerHandler

  • kwargs – forwarded to the Base Client class

addPilotReferences(cls, pilotRef, VO, gridType, pilotStampDict, **kwargs)

Add a new pilot job reference

Automatically created for the service function export_addPilotReferences()

Parameters:

  • pilotRef – pilotRef

  • VO – VO

  • gridType – gridType

  • pilotStampDict – pilotStampDict

property call

To be removed once we’re sure self.call has been removed

Type:

Deprecated

clearPilots(cls, interval, aborted_interval, **kwargs)

Automatically created for the service function export_clearPilots()

Parameters:

  • interval – interval

  • aborted_interval – aborted_interval

countPilots(cls, condDict, older, newer, timeStamp, **kwargs)

Set the pilot agent status

Automatically created for the service function export_countPilots()

Parameters:

  • condDict – condDict

  • older – older

  • newer – newer

  • timeStamp – timeStamp

deletePilots(cls, pilotIDs, **kwargs)

Automatically created for the service function export_deletePilots()

Parameters:

pilotIDs – pilotIDs

executeRPC(*parms, **kws)

This method extracts some parameters from kwargs that are used as parameter of the constructor or RPCClient. Unfortunately, only a few of all the available parameters of BaseClient are exposed.

Parameters:

  • rpc – if an RPC client is passed, use that one

  • timeout – we can change the timeout on a per call bases. Default is self.timeout

  • url – We can specify which url to use

getClientKWArgs()

Returns a copy of the connection arguments

getCurrentPilotCounters(cls, attrDict, **kwargs)

Get pilot counters per Status with attrDict selection. Final statuses are given for the last day.

Automatically created for the service function export_getCurrentPilotCounters()

Parameters:

attrDict – attrDict

getGroupedPilotSummary(cls, columnList, **kwargs)

Get pilot summary showing grouped by columns in columnList, all pilot states and pilot efficiencies in a single row.

Parameters:

columnList – a list of columns to GROUP BY (less status column)

Returns:

a dictionary containing column names and data records

Automatically created for the service function export_getGroupedPilotSummary()

getPilotInfo(cls, pilotReference, **kwargs)

Get the info about a given pilot job reference

Automatically created for the service function export_getPilotInfo()

Parameters:

pilotReference – pilotReference

getPilotLoggingInfo(self, pilotReference, **kwargs)

Get the pilot logging info for the Grid job reference

Automatically created for the service function export_getPilotLoggingInfo()

Parameters:

pilotReference – pilotReference

getPilotOutput(self, pilotReference, **kwargs)

Get the pilot job standard output and standard error files for a pilot reference. Handles both classic, CE-based logs and remote logs. The type of logs returned is determined by the server.

Parameters:

pilotReference (str) – pilot reference (e.g. htcondorce://ce13.pic.es/19126986.5)

Returns:

S_OK or S_ERROR

Return type:

dict

Automatically created for the service function export_getPilotOutput()

getPilotSummary(cls, startdate, enddate, **kwargs)

Get summary of the status of the LCG Pilot Jobs

Automatically created for the service function export_getPilotSummary()

Parameters:

  • startdate – startdate

  • enddate – enddate

getPilots(cls, jobID, **kwargs)

Get pilots executing/having executed the Job

Automatically created for the service function export_getPilots()

Parameters:

jobID – jobID

getServer()

Getter for the server url. Useful ?

httpsClient

alias of TornadoClient

selectPilots(cls, condDict, **kwargs)

Select pilots given the selection conditions

Automatically created for the service function export_selectPilots()

Parameters:

condDict – condDict

setAccountingFlag(cls, pilotRef, mark, **kwargs)

Set the pilot AccountingSent flag

Automatically created for the service function export_setAccountingFlag()

Parameters:

  • pilotRef – pilotRef

  • mark – mark

setJobForPilot(cls, jobID, pilotRef, destination, **kwargs)

Report the DIRAC job ID which is executed by the given pilot job

Automatically created for the service function export_setJobForPilot()

Parameters:

  • jobID – jobID

  • pilotRef – pilotRef

  • destination – destination

setPilotBenchmark(cls, pilotRef, mark, **kwargs)

Set the pilot agent benchmark

Automatically created for the service function export_setPilotBenchmark()

Parameters:

  • pilotRef – pilotRef

  • mark – mark

setPilotStatus(cls, pilotRef, status, destination, reason, gridSite, queue, **kwargs)

Set the pilot agent status

Automatically created for the service function export_setPilotStatus()

Parameters:

  • pilotRef – pilotRef

  • status – status

  • destination – destination

  • reason – reason

  • gridSite – gridSite

  • queue – queue

setServer(url)

Set the server URL used by default

Parameters:

url – url of the service

storePilotOutput(cls, pilotReference, output, error, **kwargs)

Store the pilot output and error

Automatically created for the service function export_storePilotOutput()

Parameters:

  • pilotReference – pilotReference

  • output – output

  • error – error