Skip to content

Pingclient

Classes

PingClient

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

Ping client class

Functions

ping
ping()

This is a light‑weight “are you alive?” call (ping request) to the configured Rucio.

A quick way to verify (without any required authentication):

  • Network connectivity between the client and the server.

  • Whether the server process is running and able to respond.

  • The server’s build / version.

RETURNS DESCRIPTION
dict[str, Any]

A dictionary with a single key: the server version (e.g. {'version': '37.0.0'})

RAISES DESCRIPTION
RucioException

If the HTTP status code is not 200 OK.

Examples:

Example

Basic connectivity check:

from rucio.client.pingclient import PingClient
ping_client = PingClient()

try:
    info = ping_client.ping()
    print(f"Connected to Rucio {info['version']}")
except Exception as err:
    print(f"Ping failed: {err}")

Functions