Модуль theforeman.foreman.subnet_info — Получение информации о подсетях

Примечание

Этот модуль входит в состав коллекции theforeman.foreman (версия 4.2.0).

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

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: theforeman.foreman.subnet_info.

Новое в theforeman.foreman 2.1.0

Обзор
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

Получение информации о подсетях

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
location строка	Метка расположения для сужения поиска.
name строка	Имя ресурса, для которого требуется информация. Взаимоисключающий параметр с search.
organization строка	Имя организации для сужения поиска.
password строка / обязательно	Пароль пользователя, который получает доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_PASSWORD`.
search строка	Запрос для поиска. Если None, и name не задано, возвращаются все ресурсы. Взаимоисключающий параметр с name.
server_url строка / обязательно	URL-адрес сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_SERVER_URL`.
username строка / обязательно	Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs булево	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: "Show a subnet"
  theforeman.foreman.subnet_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "subnet.example.com"

- name: "Show all subnets with domain example.com"
  theforeman.foreman.subnet_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "domain = example.com"

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

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

Ключ	Описание
subnet словарь	Подробная информация о найденной подсети Возвращаемое значение: успех и был передан параметр name
subnets список / элементы=словарь	Список всех найденных подсетей и их подробностей Возвращаемое значение: успех и был передан параметр search

Авторы

Evgeni Golov (@evgeni)

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

© 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/theforeman/foreman/subnet_info_module.html