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

Примечание

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

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

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

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

Добавлено в theforeman.foreman 2.3.0

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

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

Получение информации об организации (организациях)

Требования

Следующие требования необходимы на узле, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
location string	Метка местоположения, по которому следует ограничить поиск.
name string	Имя ресурса, информацию о котором нужно получить. Несовместим с параметром search.
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization string	Имя организации, по которой следует ограничить поиск.
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_PASSWORD`.
search string	Используемый поисковый запрос Если значение не задано и параметр name не указан, возвращаются все ресурсы. Несовместим с параметром name.
server_url string / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или аутентификация Kerberos через Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли 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 dictionary	Сведения о найденной организации Возвращается: при успешном выполнении, если передан параметр name
organizations list / elements=dictionary	Список всех найденных организаций и сведений о них Возвращается: при успешном выполнении, если передан параметр search

Авторы

Stejskal Leos (@lstejska)

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

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