Модуль community.hrobot.server_info – Получение информации об одном или нескольких серверах

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.0.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 строка / обязательно	Пароль пользователя веб-сервиса Robot.
hetzner_user строка / обязательно	Имя пользователя пользователя веб-сервиса Robot.
server_name строка	Ограничить список результатами по серверам с таким именем.
server_number целое число	Ограничить список результатами по серверу с таким номером.

Атрибуты

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

Примеры

- 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 список / элементы=словарь	Список серверов, соответствующих указанным параметрам. Возвращается при: успехе
cancelled логическое	Признак отмены сервера. Возвращается при: успехе Пример: `false`
cpanel логическое	Флаг доступности установки cPanel. Возвращается при: `full_info=true` Пример: `true`
dc строка	ЦОД, в котором расположен сервер. Возвращается при: успехе Пример: `"NBG1-DC1"`
hot_swap логическое	Флаг доступности Hot Swap. Возвращается при: `full_info=true` Пример: `true`
ip список / элементы=строка	Список назначенных отдельных IP-адресов. Возвращается при: успехе Пример: `["123.123.123.123"]`
linked_storagebox целое	Идентификатор связанного хранилища. Возвращается при: `full_info=true` Пример: `12345`
paid_until строка	Дата окончания оплаты за сервер. Возвращается при: успехе Пример: `"2018-08-04"`
plesk логическое	Флаг доступности установки Plesk. Возвращается при: `full_info=true` Пример: `true`
product строка	Наименование продукта сервера. Возвращается при: успехе Пример: `"EQ 8"`
rescue логическое	Доступность системы восстановления. Возвращается при: `full_info=true` Пример: `false`
reset логическое	Возможность автоматической перезагрузки сервера. Возвращается при: `full_info=true` Пример: `true`
server_ip строка	Основной IP-адрес сервера. Возвращается при: успехе Пример: `"123.123.123.123"`
server_ipv6_net строка	Основной IPv6-адрес сети сервера. Возвращается при: успехе Пример: `"2a01:f48:111:4221::"`
server_name строка	Определённое пользователем имя сервера. Возвращается при: успехе Пример: `"server1"`
server_number целое	Числовой идентификатор сервера. Возвращается при: успехе Пример: `321`
status строка	Статус сервера. Возвращается при: успехе Возможные значения: `"ready"` `"in process"` Пример: `"ready"`

subnet список / элементы=словарь	Список назначенных подсетей. Возвращается при: успехе Пример: `[{"ip": "2a01:4f8:111:4221::", "mask": 64}]`
ip строка	Первый IP-адрес в подсети. Возвращается при: успехе Пример: `"2a01:4f8:111:4221::"`
mask строка	Длина маски в битах. Возвращается при: успехе Пример: `"64"`
traffic строка	Квота на бесплатный трафик. `unlimited` в случае неограниченного трафика. Возвращается при: успехе Пример: `"5 TB"`
vnc булево	Флаг наличия VNC. Возвращается при: `full_info=true` Пример: `true`
windows булево	Флаг наличия Windows. Возвращается при: `full_info=true` Пример: `true`
wol булево	Флаг наличия Wake On Lan. Возвращается при: `full_info=true` Пример: `true`

Авторы

Felix Fontein (@felixfontein)

Ссылки на сборку

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