Exportclient

Classes¶

ExportClient ¶

ExportClient(
    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,
)

RSE client class for exporting data from Rucio

Functions¶

export_data ¶

export_data(distance=True)

Retrieve a detailed snapshot of the current RSE configuration.

The exported information includes all registered RSEs with their settings and attributes. When distance is True, the RSE distance matrix is included as well. The snapshot is intended for use cases such as configuration back‑ups, migrations between instances, and monitoring (e.g. generating monitoring dashboards).

PARAMETER	DESCRIPTION
`distance`	If True (default), the server also returns the inter‑RSE distance matrix in the payload. Note: Omitting the distance information can significantly reduce the response size and improve transfer times. TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`dict[str, Any]`	A nested dictionary that mirrors the server‑side JSON structure. The top‑level keys are: `rses`: Per‑RSE settings (name, deterministic flag, QoS class, supported protocol, etc.). `distances`: Pairwise RSE‑to‑RSE distance values (only present when `distance=True`).

RAISES	DESCRIPTION
`RucioException`	Raised if the HTTP status code is not 200 OK.

Examples:

Example

Retrieve a full export of all configured RSEs, including their attributes and inter-RSE distances:

from rucio.client.exportclient import ExportClient

export_client = ExportClient()

try:
    rse_data = export_client.export_data()  # distance=True by default
    print(f"Full RSE properties: {rse_data}")
except Exception as err:
    print(f"Action failed: {err}")