Skip to content

Accountlimitclient

AccountLimitClient(rucio_host=None, auth_host=None, account=None, ca_cert=None, auth_type=None, creds=None, timeout=600, user_agent='rucio-clients', vo=None, logger=LOG)

Account limit client class for working with account limits

Constructor of the BaseClient.

Parameters:

Name Type Description Default
rucio_host Optional[str]

The address of the rucio server, if None it is read from the config file.

None
rucio_port

The port of the rucio server, if None it is read from the config file.

required
auth_host Optional[str]

The address of the rucio authentication server, if None it is read from the config file.

None
auth_port

The port of the rucio authentication server, if None it is read from the config file.

required
account Optional[str]

The account to authenticate to rucio.

None
use_ssl

Enable or disable ssl for commucation. Default is enabled.

required
ca_cert Optional[str]

The path to the rucio server certificate.

None
auth_type Optional[str]

The type of authentication (e.g.: 'userpass', 'kerberos' ...)

None
creds Optional[dict[str, Any]]

Dictionary with credentials needed for authentication.

None
user_agent Optional[str]

Indicates the client.

'rucio-clients'
vo Optional[str]

The VO to authenticate into.

None
logger Logger

Logger object to use. If None, use the default LOG created by the module

LOG

set_account_limit(account, rse, bytes_, locality)

Sets an account limit for a given limit scope.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse str

The rse name.

required
bytes_ int

An integer with the limit in bytes.

required
locality Literal['local', 'global']

The scope of the account limit. 'local' or 'global'.

required

Returns:

Type Description
bool

True if quota was created successfully else False.

delete_account_limit(account, rse, locality)

Deletes an account limit for a given limit scope.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse str

The rse name.

required
locality Literal['local', 'global']

The scope of the account limit. 'local' or 'global'.

required

Returns:

Type Description
bool

True if quota was created successfully else False.

set_local_account_limit(account, rse, bytes_)

Sends the request to set an account limit for an account.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse str

The rse name.

required
bytes_ int

An integer with the limit in bytes.

required

Returns:

Type Description
bool

True if quota was created successfully else False.

delete_local_account_limit(account, rse)

Sends the request to remove an account limit.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse str

The rse name.

required

Returns:

Type Description
bool

True if quota was removed successfully. False otherwise.

Raises:

Type Description
AccountNotFound

if account doesn't exist.

set_global_account_limit(account, rse_expression, bytes_)

Sends the request to set a global account limit for an account.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse_expression str

The rse expression.

required
bytes_ int

An integer with the limit in bytes.

required

Returns:

Type Description
bool

True if quota was created successfully else False.

delete_global_account_limit(account, rse_expression)

Sends the request to remove a global account limit.

Parameters:

Name Type Description Default
account str

The name of the account.

required
rse_expression str

The rse expression.

required

Returns:

Type Description
bool

True if quota was removed successfully. False otherwise.

Raises:

Type Description
AccountNotFound

if account doesn't exist.