Configclient

Classes¶

ConfigClient ¶

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

Client class for working with the configuration

Functions¶

get_config ¶

get_config(section=None, option=None)

Sends the request to get the matching configuration.

PARAMETER	DESCRIPTION
`section`	the optional name of the section. TYPE: `Optional[str]` DEFAULT: `None`
`option`	the optional option within the section. TYPE: `Optional[str]` DEFAULT: `None`

RETURNS	DESCRIPTION
`dict[str, Any]`	dictionary containing the configuration.

set_config_option ¶

set_config_option(
    section, option, value, use_body_for_params=True
)

Sends the request to create or set an option within a section. Missing sections will be created.

PARAMETER	DESCRIPTION
`section`	the name of the section. TYPE: `str`
`option`	the name of the option. TYPE: `str`
`value`	the value to set on the config option TYPE: `Any`
`use_body_for_params`	send parameters in a json-encoded request body instead of url-encoded TODO: remove this parameter The format of the /config endpoint was recently changed. We migrated from performing a PUT on "/config/ / TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`bool`	True if option was removed successfully. False otherwise.

delete_config_option ¶

delete_config_option(section, option)

Sends the request to remove an option from a section

PARAMETER	DESCRIPTION
`section`	the name of the section. TYPE: `str`
`option`	the name of the option. TYPE: `str`

RETURNS	DESCRIPTION
`bool`	True if option was removed successfully. False otherwise.