Модуль community.hrobot.server_info — запрос сведений об одном или нескольких серверах

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать её в плейбуке, укажите: community.hrobot.server_info.

Добавлено в community.hrobot 1.2.0

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Запрашивает сведения об одном или нескольких серверах.

Параметры

Параметр	Комментарии
full_info boolean	Следует ли предоставлять полные сведения о каждом сервере. Установка этого параметра в `true` требует одного REST-вызова на сервер, что выполняется медленно и уменьшает доступный лимит запросов. Используйте с осторожностью. Если указан `server_number`, этот параметр всегда считается равным `true`. Варианты: `false` ← (по умолчанию) `true`
hetzner_password string / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user string / обязательный	Имя пользователя веб-службы Robot.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения лимита запросов. Укажите `0`, чтобы отключить повторные попытки. Укажите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
server_name string	Ограничить список результатов серверами с этим именем.
server_number integer	Ограничить список результатов сервером с этим номером.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hrobot.robot добавлено в community.hrobot 1.6.0	Используйте `group/community.hrobot.robot` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	При работе в режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске подряд вне режима проверки с теми же аргументами второй вызов сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или сведения о которой он запрашивает, не изменилась существенным образом.

Примеры

---
- name: Query a list of all servers
  community.hrobot.server_info:
    hetzner_user: foo
    hetzner_password: bar
  register: result

- name: Query a specific server
  community.hrobot.server_info:
    hetzner_user: foo
    hetzner_password: bar
    server_number: 23
  register: result

- name: Output data on specific server
  ansible.builtin.debug:
    msg: "Server name: {{ result.servers[0].server_name }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
servers list / elements=dictionary	Список серверов, соответствующих заданным параметрам. Возвращается: при успехе
cancelled boolean	Отменён ли сервер. Возвращается: при успехе Пример: `false`
cpanel boolean	Признак доступности установки cPanel. Возвращается: если `full_info=true` Пример: `true`
dc string	Центр обработки данных, в котором расположен сервер. Возвращается: при успехе Пример: `"NBG1-DC1"`
hot_swap boolean	Признак доступности горячей замены. Возвращается: если `full_info=true` Пример: `true`
ip list / elements=string	Список назначенных отдельных IP-адресов. Возвращается: при успехе Пример: `["123.123.123.123"]`
linked_storagebox integer	ID связанного Storage Box. Возвращается: если `full_info=true` Пример: `12345`
paid_until string	Дата, до которой сервер оплачен. Возвращается: при успехе Пример: `"2018-08-04"`
plesk boolean	Признак доступности установки Plesk. Возвращается: если `full_info=true` Пример: `true`
product string	Название продукта сервера. Возвращается: при успехе Пример: `"EQ 8"`
rescue boolean	Доступна ли система восстановления. Возвращается: если `full_info=true` Пример: `false`
reset boolean	Можно ли автоматически перезагрузить сервер. Возвращается: если `full_info=true` Пример: `true`
server_ip string	Основной IP-адрес сервера. Возвращается: при успехе Пример: `"123.123.123.123"`
server_ipv6_net string	Основной сетевой адрес IPv6 сервера. Возвращается: при успехе Пример: `"2a01:f48:111:4221::"`
server_name string	Заданное пользователем имя сервера. Возвращается: при успехе Пример: `"server1"`
server_number integer	Числовой идентификатор сервера. Возвращается: при успехе Пример: `321`
status string	Состояние сервера. Возвращается: при успехе Возможные значения: `"ready"` `"in process"` Пример: `"ready"`
subnet list / elements=dictionary	Список назначенных подсетей. Возвращается: при успехе Пример: `[{"ip": "2a01:4f8:111:4221::", "mask": 64}]`
ip string	Первый IP-адрес в подсети. Возвращается: при успехе Пример: `"2a01:4f8:111:4221::"`
mask string	Длина маски в битах. Возвращается: при успехе Пример: `"64"`
traffic string	Объём бесплатного трафика. `unlimited` в случае безлимитного трафика. Возвращается: при успехе Пример: `"5 TB"`
vnc boolean	Признак доступности установки VNC. Возвращается: если `full_info=true` Пример: `true`
windows boolean	Признак доступности установки Windows. Возвращается: если `full_info=true` Пример: `true`
wol boolean	Признак доступности Wake On LAN. Возвращается: если `full_info=true` Пример: `true`

Авторы

Felix Fontein (@felixfontein)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/hrobot/server_info_module.html