Сеансы и процессы¶
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. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к |
: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
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
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
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
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. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к |
: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
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
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
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. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к |
: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
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
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
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. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к |
: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
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
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
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. Ключи соответствуют полям вывода, дефисы заменены на подчёркивания, числовые значения приведены к |
: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
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
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
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
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
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
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.