Перейти к содержанию

Сеансы и процессы

UserSession

UserSession

Сеансы пользователей.

info staticmethod

info(session: Session, cluster: str, user_session: str, licenses: bool = False, cluster_user: str | None = None, cluster_pwd: str | None = None) -> RacRecord

Возвращает сведения о сеансе пользователя.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
user_session str

Номер сеанса.

required
licenses bool

Показать информацию о занятых лицензиях.

False
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
RacRecord

dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к int.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/session.py
@staticmethod
def info(
    session: Session,
    cluster: str,
    user_session: str,
    licenses: bool = False,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> RacRecord:
    """Возвращает сведения о сеансе пользователя.

    Args:
        cluster: Идентификатор (UUID) кластера.
        user_session: Номер сеанса.
        licenses: Показать информацию о занятых лицензиях.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к ``int``.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("session"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("info"),
            Arg(user_session, "--session={}"),
            Flag(licenses, "--licenses"),
        )
    ).to_dict()

list staticmethod

list(session: Session, cluster: str, infobase: str | None = None, licenses: bool = False, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список сеансов пользователей кластера.

Список можно сузить до одной информационной базы.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
infobase str | None

Идентификатор (UUID) информационной базы.

None
licenses bool

Показать информацию о занятых лицензиях.

False
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/session.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    infobase: str | None = None,
    licenses: bool = False,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список сеансов пользователей кластера.

    Список можно сузить до одной информационной базы.

    Args:
        cluster: Идентификатор (UUID) кластера.
        infobase: Идентификатор (UUID) информационной базы.
        licenses: Показать информацию о занятых лицензиях.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("session"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
            Arg(infobase, "--infobase={}"),
            Flag(licenses, "--licenses"),
        )
    ).to_list()

terminate staticmethod

terminate(session: Session, cluster: str, user_session: str, error_message: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Завершает сеанс пользователя.

Пользователь получит сообщение, переданное в error_message.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
user_session str

Номер сеанса.

required
error_message str | None

Сообщение, которое увидит пользователь.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/session.py
@staticmethod
def terminate(
    session: Session,
    cluster: str,
    user_session: str,
    error_message: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Завершает сеанс пользователя.

    Пользователь получит сообщение, переданное в ``error_message``.

    Args:
        cluster: Идентификатор (UUID) кластера.
        user_session: Номер сеанса.
        error_message: Сообщение, которое увидит пользователь.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("session"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("terminate"),
            Arg(user_session, "--session={}"),
            Arg(error_message, "--error-message={}"),
        )
    )

interrupt_current_server_call staticmethod

interrupt_current_server_call(session: Session, cluster: str, user_session: str, error_message: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Прерывает текущий серверный вызов в сеансе пользователя.

В отличие от :meth:terminate сам сеанс не завершается.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
user_session str

Номер сеанса.

required
error_message str | None

Сообщение, которое увидит пользователь.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/session.py
@staticmethod
def interrupt_current_server_call(
    session: Session,
    cluster: str,
    user_session: str,
    error_message: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Прерывает текущий серверный вызов в сеансе пользователя.

    В отличие от :meth:`terminate` сам сеанс не завершается.

    Args:
        cluster: Идентификатор (UUID) кластера.
        user_session: Номер сеанса.
        error_message: Сообщение, которое увидит пользователь.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("session"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("interrupt-current-server-call"),
            Arg(user_session, "--session={}"),
            Arg(error_message, "--error-message={}"),
        )
    )

Connection

Connection

Соединения клиентов с информационными базами.

info staticmethod

info(session: Session, cluster: str, connection: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> RacRecord

Возвращает сведения о соединении с информационной базой.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
connection str

Идентификатор соединения.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
RacRecord

dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к int.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/connection.py
@staticmethod
def info(
    session: Session,
    cluster: str,
    connection: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> RacRecord:
    """Возвращает сведения о соединении с информационной базой.

    Args:
        cluster: Идентификатор (UUID) кластера.
        connection: Идентификатор соединения.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к ``int``.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("connection"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("info"),
            Arg(connection, "--connection={}"),
        )
    ).to_dict()

list staticmethod

list(session: Session, cluster: str, process: str | None = None, infobase: str | None = None, infobase_user: str | None = None, infobase_pwd: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список соединений с информационными базами кластера.

Список можно сузить по рабочему процессу или по информационной базе.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
process str | None

Идентификатор рабочего процесса: только его соединения.

None
infobase str | None

Идентификатор (UUID) информационной базы: только её соединения.

None
infobase_user str | None

Имя пользователя информационной базы.

None
infobase_pwd str | None

Пароль пользователя информационной базы.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/connection.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    process: str | None = None,
    infobase: str | None = None,
    infobase_user: str | None = None,
    infobase_pwd: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список соединений с информационными базами кластера.

    Список можно сузить по рабочему процессу или по информационной базе.

    Args:
        cluster: Идентификатор (UUID) кластера.
        process: Идентификатор рабочего процесса: только его соединения.
        infobase: Идентификатор (UUID) информационной базы: только её соединения.
        infobase_user: Имя пользователя информационной базы.
        infobase_pwd: Пароль пользователя информационной базы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("connection"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
            Arg(process, "--process={}"),
            Arg(infobase, "--infobase={}"),
            Arg(infobase_user, "--infobase-user={}"),
            Arg(infobase_pwd, "--infobase-pwd={}"),
        )
    ).to_list()

disconnect staticmethod

disconnect(session: Session, cluster: str, process: str, connection: str, infobase_user: str | None = None, infobase_pwd: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Принудительно разрывает соединение с информационной базой.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
process str

Идентификатор рабочего процесса.

required
connection str

Идентификатор соединения.

required
infobase_user str | None

Имя пользователя информационной базы.

None
infobase_pwd str | None

Пароль пользователя информационной базы.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/connection.py
@staticmethod
def disconnect(
    session: Session,
    cluster: str,
    process: str,
    connection: str,
    infobase_user: str | None = None,
    infobase_pwd: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Принудительно разрывает соединение с информационной базой.

    Args:
        cluster: Идентификатор (UUID) кластера.
        process: Идентификатор рабочего процесса.
        connection: Идентификатор соединения.
        infobase_user: Имя пользователя информационной базы.
        infobase_pwd: Пароль пользователя информационной базы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("connection"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("disconnect"),
            Arg(process, "--process={}"),
            Arg(connection, "--connection={}"),
            Arg(infobase_user, "--infobase-user={}"),
            Arg(infobase_pwd, "--infobase-pwd={}"),
        )
    )

Process

Process

Рабочие процессы на рабочих серверах.

info staticmethod

info(session: Session, cluster: str, process: str, licenses: bool = False, cluster_user: str | None = None, cluster_pwd: str | None = None) -> RacRecord

Возвращает сведения о рабочем процессе.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
process str

Идентификатор рабочего процесса.

required
licenses bool

Показать информацию о занятых лицензиях.

False
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
RacRecord

dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к int.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/process.py
@staticmethod
def info(
    session: Session,
    cluster: str,
    process: str,
    licenses: bool = False,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> RacRecord:
    """Возвращает сведения о рабочем процессе.

    Args:
        cluster: Идентификатор (UUID) кластера.
        process: Идентификатор рабочего процесса.
        licenses: Показать информацию о занятых лицензиях.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к ``int``.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("process"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("info"),
            Arg(process, "--process={}"),
            Flag(licenses, "--licenses"),
        )
    ).to_dict()

list staticmethod

list(session: Session, cluster: str, server: str, licenses: bool = False, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список рабочих процессов указанного рабочего сервера.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
licenses bool

Показать информацию о занятых лицензиях.

False
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/process.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    server: str,
    licenses: bool = False,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список рабочих процессов указанного рабочего сервера.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        licenses: Показать информацию о занятых лицензиях.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("process"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
            Arg(server, "--server={}"),
            Flag(licenses, "--licenses"),
        )
    ).to_list()

Lock

Lock

Блокировки, удерживаемые сеансами.

list staticmethod

list(session: Session, cluster: str, infobase: str | None = None, connection: str | None = None, infobase_session: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список блокировок, удерживаемых сеансами.

Список можно сузить по информационной базе, соединению или сеансу.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
infobase str | None

Идентификатор (UUID) информационной базы.

None
connection str | None

Идентификатор соединения.

None
infobase_session str | None

Номер сеанса информационной базы.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/lock.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    infobase: str | None = None,
    connection: str | None = None,
    infobase_session: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список блокировок, удерживаемых сеансами.

    Список можно сузить по информационной базе, соединению или сеансу.

    Args:
        cluster: Идентификатор (UUID) кластера.
        infobase: Идентификатор (UUID) информационной базы.
        connection: Идентификатор соединения.
        infobase_session: Номер сеанса информационной базы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("lock"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
            Arg(infobase, "--infobase={}"),
            Arg(connection, "--connection={}"),
            Arg(infobase_session, "--session={}"),
        )
    ).to_list()

Manager

Manager

Менеджеры кластера.

info staticmethod

info(session: Session, cluster: str, manager: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> RacRecord

Возвращает сведения о менеджере кластера.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
manager str

Идентификатор менеджера.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
RacRecord

dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к int.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/manager.py
@staticmethod
def info(
    session: Session,
    cluster: str,
    manager: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> RacRecord:
    """Возвращает сведения о менеджере кластера.

    Args:
        cluster: Идентификатор (UUID) кластера.
        manager: Идентификатор менеджера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к ``int``.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("manager"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("info"),
            Arg(manager, "--manager={}"),
        )
    ).to_dict()

list staticmethod

list(session: Session, cluster: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список менеджеров кластера.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/manager.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список менеджеров кластера.

    Args:
        cluster: Идентификатор (UUID) кластера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("manager"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
        )
    ).to_list()

Service

Service

Службы, зарегистрированные в кластере.

list staticmethod

list(session: Session, cluster: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список служб, зарегистрированных в кластере.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/service.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список служб, зарегистрированных в кластере.

    Args:
        cluster: Идентификатор (UUID) кластера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("service"),
            Arg(cluster, "--cluster={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
        )
    ).to_list()

ServiceSetting

ServiceSetting

Настройки служб на рабочих серверах.

info staticmethod

info(session: Session, cluster: str, server: str, setting: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> RacRecord

Возвращает настройку службы на рабочем сервере.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
setting str

Идентификатор настройки службы.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
RacRecord

dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к int.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def info(
    session: Session,
    cluster: str,
    server: str,
    setting: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> RacRecord:
    """Возвращает настройку службы на рабочем сервере.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        setting: Идентификатор настройки службы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        dict[str, str | int]: одна запись RAC. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к ``int``.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("info"),
            Arg(setting, "--setting={}"),
        )
    ).to_dict()

list staticmethod

list(session: Session, cluster: str, server: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает список настроек служб рабочего сервера.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def list(
    session: Session,
    cluster: str,
    server: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает список настроек служб рабочего сервера.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("list"),
        )
    ).to_list()

insert staticmethod

insert(session: Session, cluster: str, server: str, service_name: str, infobase_name: str | None = None, service_data_dir: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> str

Добавляет настройку службы на рабочем сервере.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
service_name str

Имя службы.

required
infobase_name str | None

Имя информационной базы, к которой привязана служба.

None
service_data_dir str | None

Каталог данных службы.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
str

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def insert(
    session: Session,
    cluster: str,
    server: str,
    service_name: str,
    infobase_name: str | None = None,
    service_data_dir: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> str:
    """Добавляет настройку службы на рабочем сервере.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        service_name: Имя службы.
        infobase_name: Имя информационной базы, к которой привязана служба.
        service_data_dir: Каталог данных службы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("insert"),
            Arg(service_name, "--service-name={}"),
            Arg(infobase_name, "--infobase-name={}"),
            Arg(service_data_dir, "--service-data-dir={}"),
        )
    )

update staticmethod

update(session: Session, cluster: str, server: str, setting: str, service_data_dir: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Изменяет настройку службы.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
setting str

Идентификатор настройки службы.

required
service_data_dir str | None

Новый каталог данных службы.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def update(
    session: Session,
    cluster: str,
    server: str,
    setting: str,
    service_data_dir: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Изменяет настройку службы.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        setting: Идентификатор настройки службы.
        service_data_dir: Новый каталог данных службы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("update"),
            Arg(setting, "--setting={}"),
            Arg(service_data_dir, "--service-data-dir={}"),
        )
    )

get_service_data_dirs_for_transfer staticmethod

get_service_data_dirs_for_transfer(session: Session, cluster: str, server: str, service_name: str | None = None, cluster_user: str | None = None, cluster_pwd: str | None = None) -> list[RacRecord]

Возвращает каталоги данных служб, которые нужно перенести.

Используется при переносе службы на другой рабочий сервер.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
service_name str | None

Имя службы; если не указано — по всем службам сервера.

None
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
list[RacRecord]

list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def get_service_data_dirs_for_transfer(
    session: Session,
    cluster: str,
    server: str,
    service_name: str | None = None,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> list[RacRecord]:
    """Возвращает каталоги данных служб, которые нужно перенести.

    Используется при переносе службы на другой рабочий сервер.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        service_name: Имя службы; если не указано — по всем службам сервера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        list[dict[str, str | int]]: записи RAC. Пустой список, если RAC ничего не вернул.

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.exec(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("get-service-data-dirs-for-transfer"),
            Arg(service_name, "--service-name={}"),
        )
    ).to_list()

remove staticmethod

remove(session: Session, cluster: str, server: str, setting: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Удаляет настройку службы.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
setting str

Идентификатор настройки службы.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def remove(
    session: Session,
    cluster: str,
    server: str,
    setting: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Удаляет настройку службы.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        setting: Идентификатор настройки службы.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("remove"),
            Arg(setting, "--setting={}"),
        )
    )

apply staticmethod

apply(session: Session, cluster: str, server: str, cluster_user: str | None = None, cluster_pwd: str | None = None) -> None

Применяет настройки служб на рабочем сервере.

Parameters:

Name Type Description Default
cluster str

Идентификатор (UUID) кластера.

required
server str

Идентификатор (UUID) рабочего сервера.

required
cluster_user str | None

Имя администратора кластера.

None
cluster_pwd str | None

Пароль администратора кластера.

None

Returns:

Type Description
None

None

:raises raclib.errors.RACNotFoundError: файл rac не найден или не может быть запущен. :raises raclib.errors.RACTimeoutError: RAC не ответил за timeout секунд, заданный в сессии. :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий raclib.errors.

Source code in src/raclib/cmd/servicesetting.py
@staticmethod
def apply(
    session: Session,
    cluster: str,
    server: str,
    cluster_user: str | None = None,
    cluster_pwd: str | None = None,
) -> None:
    """Применяет настройки служб на рабочем сервере.

    Args:
        cluster: Идентификатор (UUID) кластера.
        server: Идентификатор (UUID) рабочего сервера.
        cluster_user: Имя администратора кластера.
        cluster_pwd: Пароль администратора кластера.

    Returns:
        None

    :raises raclib.errors.RACNotFoundError: файл ``rac`` не найден или не может быть запущен.
    :raises raclib.errors.RACTimeoutError: RAC не ответил за ``timeout`` секунд, заданный в сессии.
    :raises raclib.errors.UnknownError: RAC вернул ошибку, которой нет в таблице соответствий ``raclib.errors``.
    """
    return session.call(
        Command(
            Arg("service-setting"),
            Arg(cluster, "--cluster={}"),
            Arg(server, "--server={}"),
            Arg(cluster_user, "--cluster-user={}"),
            Arg(cluster_pwd, "--cluster-pwd={}"),
            Arg("apply"),
        )
    )