Skip to main content

RuleClient

add_replication_rule

Arguments:

dids: The data identifier set.

copies: The number of replicas.

rse_expression: Boolean string expression to give the list of RSEs.

priority: Priority of the transfers.

lifetime: The lifetime of the replication rules (in seconds).

grouping: ALL - All files will be replicated to the same RSE. DATASET - All files in the same dataset will be replicated to the same RSE. NONE - Files will be completely spread over all allowed RSEs without any grouping considerations at all.

notify: Notification setting for the rule (Y, N, C).

source_replica_expression: RSE Expression for RSEs to be considered for source replicas.

activity: Transfer Activity to be passed to FTS.

account: The account owning the rule.

meta: Metadata, as dictionary.

ignore_availability: Option to ignore the availability of RSEs.

purge_replicas: When the rule gets deleted purge the associated replicas immediately.

ask_approval: Ask for approval of this replication rule.

asynchronous: Create rule asynchronously by judge-injector.

locked: If the rule is locked, it cannot be deleted.

delay_injection:

comment: Comment about the rule.

weight: If the weighting option of the replication rule is used, the choice of RSEs takes their weight into account.

delete_replication_rule

Deletes a replication rule and all associated locks.

Arguments:

rule_id: The id of the rule to be deleted

purge_replicas: Immediately delete the replicas.

Raises:

``: RuleNotFound, AccessDenied

get_replication_rule

Get a replication rule.

Arguments:

rule_id: The id of the rule to be retrieved.

Raises:

``: RuleNotFound

update_replication_rule

Arguments:

rule_id: The id of the rule to be retrieved.

options: Options dictionary.

Raises:

``: RuleNotFound

reduce_replication_rule

Arguments:

rule_id: Rule to be reduced.

copies: Number of copies of the new rule.

exclude_expression: RSE Expression of RSEs to exclude.

Raises:

``: RuleReplaceFailed, RuleNotFound

move_replication_rule

Move a replication rule to another RSE and, once done, delete the original one.

Arguments:

rule_id: Rule to be moved.

rse_expression: RSE expression of the new rule.

override: Configurations to update for the new rule.

Raises:

``: RuleNotFound, RuleReplaceFailed

approve_replication_rule

Arguments:

rule_id: Rule to be approved.

Raises:

``: RuleNotFound

deny_replication_rule

Arguments:

rule_id: Rule to be denied.

reason: Reason for denying the rule.

Raises:

``: RuleNotFound

list_replication_rule_full_history

List the rule history of a DID.

Arguments:

scope: The scope of the DID.

name: The name of the DID.

examine_replication_rule

Examine a replication rule for errors during transfer.

Arguments:

rule_id: Rule to be denied.

Raises:

``: RuleNotFound

list_replica_locks

List details of all replica locks for a rule.

Arguments:

rule_id: Rule to be denied.

Raises:

``: RuleNotFound

list_replication_rules

List all replication rules which match a filter

Arguments:

filters: dictionary of attributes by which the rules should be filtered

Returns:

True if successful, otherwise false.