PilotManagerClient

Module that contains client access to the Pilots handler.

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

Bases: DIRAC.Core.Base.Client.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

addPilotTQReference(cls, pilotRef, taskQueueID, ownerDN, ownerGroup, broker, gridType, pilotStampDict, **kwargs)

Add a new pilot job reference

Automatically created for the service function export_addPilotTQReference()

Parameters
  • pilotRef – pilotRef

  • taskQueueID – taskQueueID

  • ownerDN – ownerDN

  • ownerGroup – ownerGroup

  • broker – broker

  • 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

getCounters(cls, table, keys, condDict, newer, timeStamp, **kwargs)

Set the pilot agent status

Automatically created for the service function export_getCounters()

Parameters
  • table – table

  • keys – keys

  • condDict – condDict

  • newer – newer

  • timeStamp – timeStamp

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, selectDict, columnList, **kwargs)

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

Parameters
  • selectDict – additional arguments to SELECT clause

  • 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(cls, pilotReference, **kwargs)

Get the pilot logging info for the Grid job reference

Automatically created for the service function export_getPilotLoggingInfo()

Parameters

pilotReference – pilotReference

getPilotMonitorSelectors(cls, **kwargs)

Get all the distinct selector values for the Pilot Monitor web portal page

Automatically created for the service function export_getPilotMonitorSelectors()

getPilotMonitorWeb(cls, selectDict, sortList, startItem, maxItems, **kwargs)

Get the summary of the pilot information for a given page in the pilot monitor in a generic format

Automatically created for the service function export_getPilotMonitorWeb()

Parameters
  • selectDict – selectDict

  • sortList – sortList

  • startItem – startItem

  • maxItems – maxItems

getPilotOutput(pilotReference, **kwargs)

Get the pilot job standard output and standard error files for the Grid job reference

Automatically created for the service function export_getPilotOutput()

Parameters

pilotReference – pilotReference

getPilotStatistics(cls, attribute, selectDict, **kwargs)

Get pilot statistics distribution per attribute value with a given selection

Automatically created for the service function export_getPilotStatistics()

Parameters
  • attribute – attribute

  • selectDict – selectDict

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

getPilotSummaryWeb(cls, selectDict, sortList, startItem, maxItems, **kwargs)

Get the summary of the pilot information for a given page in the pilot monitor in a generic format

Automatically created for the service function export_getPilotSummaryWeb()

Parameters
  • selectDict – selectDict

  • sortList – sortList

  • startItem – startItem

  • maxItems – maxItems

getPilots(cls, jobID, **kwargs)

Get pilot references and their states for : - those pilots submitted for the TQ where job is sitting - (or) the 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 DIRAC.Core.Tornado.Client.TornadoClient.TornadoClient

killPilot(cls, pilotRefList, **kwargs)

Kill the specified pilots

Automatically created for the service function export_killPilot()

Parameters

pilotRefList – pilotRefList

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