Модуль theforeman.foreman.organization_info – Получение информации об организации(ях)

Примечание

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

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

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

Для использования в плейбуке укажите: theforeman.foreman.organization_info.

Новинка в theforeman.foreman 2.3.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 organization"
  theforeman.foreman.organization_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Default Organization"

- name: "Show all organizations with 'name ~ Default'"
  theforeman.foreman.organization_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "name ~ Default"

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

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

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

Авторы

Stejskal Leos (@lstejska)

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

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