WMSAdministratorClient

Module that contains client access to the WMSAdministrator handler.

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

Bases: DIRAC.Core.Base.Client.Client

JobManagerClient sets url for the WMSAdministratorHandler.

__init__(url=None, **kwargs)

Sets URL for WMSAdministrator handler

Parameters:
  • self – self reference
  • url – url of the WMSAdministratorHandler
  • kwargs – forwarded to the Base Client class
allowSite(self, site, comment, **kwargs)

Allow the given site in the site mask

Parameters:
  • site (str) – site
  • comment (str) – comment
Returns:

S_OK()/S_ERROR()

Automatically created for the service function export_allowSite()

banSite(self, site, comment, **kwargs)

Ban the given site in the site mask

Parameters:
  • site (str) – site
  • comment (str) – comment
Returns:

S_OK()/S_ERROR()

Automatically created for the service function export_banSite()

clearMask(cls, **kwargs)

Clear up the entire site mask

Returns:S_OK()/S_ERROR()

Automatically created for the service function export_clearMask()

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

Get all the site parameters in the site mask

Returns:dict

Automatically created for the service function export_getAllSiteMaskStatus()

getJobPilotOutput(self, jobID, **kwargs)

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

Parameters:jobID (str) – job ID
Returns:S_OK(dict)/S_ERROR()

Automatically created for the service function export_getJobPilotOutput()

getServer()

Getter for the server url. Useful ?

getSiteMask(cls, siteState, **kwargs)

Get the site mask

Parameters:siteState (str) – site status
Returns:S_OK(list)/S_ERROR()

Automatically created for the service function export_getSiteMask()

getSiteMaskLogging(cls, sites, **kwargs)

Get the site mask logging history

Parameters:sites (list) – sites
Returns:S_OK(dict)/S_ERROR()

Automatically created for the service function export_getSiteMaskLogging()

getSiteMaskStatus(cls, sites, **kwargs)

Get the site mask of given site(s) with columns ‘site’ and ‘status’ only

Parameters:sites (list or str) – list of sites or site
Returns:S_OK()/S_ERROR() – S_OK contain dict or str

Automatically created for the service function export_getSiteMaskStatus()

getSiteMaskSummary(cls, **kwargs)

Get the mask status for all the configured sites

Returns:S_OK(dict)/S_ERROR()

Automatically created for the service function export_getSiteMaskSummary()

getSiteSummarySelectors(cls, **kwargs)

Get all the distinct selector values for the site summary web portal page

Returns:S_OK(dict)/S_ERROR()

Automatically created for the service function export_getSiteSummarySelectors()

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

Get the summary of the jobs running on sites in a generic format

Parameters:
  • selectDict (dict) – selectors
  • sortList (list) – sorting list
  • startItem (int) – start item number
  • maxItems (int) – maximum of items
Returns:

S_OK(dict)/S_ERROR()

Automatically created for the service function export_getSiteSummaryWeb()

setServer(url)

Set the server URL used by default

Parameters:url – url of the service
setSiteMask(self, siteList, **kwargs)

Set the site mask for matching. The mask is given in a form of Classad string.

Parameters:siteList (list) – site, status
Returns:S_OK()/S_ERROR()

Automatically created for the service function export_setSiteMask()

setTimeout(**kwargs)

Specify the timeout of the call. Forwarded to RPCClient

param int timeout:
 timeout for the RPC calls

Deprecated: Please use self._getRPC(timeout) or self.timeout=<value>