Модуль community.general.stacki_host – Добавление или удаление узла во фронтенд stacki

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Чтобы использовать её в playbook, укажите: community.general.stacki_host.

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

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

Используйте этот модуль для добавления или удаления узлов во фронтенд stacki через API.
Информация о stacki находится по адресу https://github.com/StackIQ/stacki.

Параметры

Параметр	Комментарии
appliance string	Устройство, которое будет использоваться при создании узла. Обязательно, если `state=present` и узел ещё не существует. Значение по умолчанию: `"backend"`
force_install boolean	Установите значение в `true` для принудительного перевода узла в состояние установки, если он уже существует в stacki. Варианты: `false` ← (по умолчанию) `true`
name string / required	Имя узла, который необходимо добавить в Stacki.
network string	Сеть, которая будет настроена на узле. В настоящее время не используется модулем. Значение по умолчанию: `"private"`
prim_intf string	Имя основного сетевого интерфейса. В настоящее время не используется модулем.
prim_intf_ip string	IP-адрес для основного сетевого интерфейса. В настоящее время не используется модулем.
prim_intf_mac string	MAC-адрес для основного сетевого интерфейса PXE-загрузки. В настоящее время не используется модулем.
rack integer	Стойка, которая будет использоваться при создании узла. Обязательно, если `state=present` и узел ещё не существует. Значение по умолчанию: `0`
rank integer	Ранг, который будет использоваться при создании узла. В терминологии Stacki ранг — это позиция машины в стойке. Обязательно, если `state=present` и узел ещё не существует. Значение по умолчанию: `0`
stacki_endpoint string / required	URL для конечной точки API Stacki.
stacki_password string / required	Пароль для аутентификации с API Stacki, но если он не указан, вместо него используется переменная окружения `stacki_password`.
stacki_user string / required	Имя пользователя для аутентификации с API Stacki, но если он не указан, вместо него используется переменная окружения `stacki_user`.
state string	Установите значение в нужное состояние для указанного узла. Варианты: `"absent"` `"present"` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз состояния "изменено" без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff будет возвращать подробную информацию о том, что изменилось (или что, возможно, нужно изменить в `check_mode`).

Примеры

- name: Add a host named test-1
  community.general.stacki_host:
    name: test-1
    stacki_user: usr
    stacki_password: pwd
    stacki_endpoint: url
    prim_intf_mac: mac_addr
    prim_intf_ip: x.x.x.x
    prim_intf: eth0

- name: Remove a host named test-1
  community.general.stacki_host:
    name: test-1
    stacki_user: usr
    stacki_password: pwd
    stacki_endpoint: url
    state: absent

Значения возврата

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

Ключ	Описание
changed boolean	ответ о том, завершился ли вызов API успешно Возвращается: всегда Пример: `true`
stdout список / элементы=строка	набор ответов от команд Возвращается: всегда Пример: `["...", "..."]`
stdout_lines список / элементы=строка	значение stdout, разделенное на список Возвращается: всегда Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Hugh Ma (@bbyhuy)

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

© 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/general/stacki_host_module.html