Модуль theforeman.foreman.resource_info – Сбор информации о ресурсах

Примечание

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

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

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

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

Новое в theforeman.foreman 1.0.0

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

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

Сбор информации о ресурсах

Псевдонимы: foreman_search_facts

Требования

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

requests

Параметры

Параметр	Комментарии
full_details псевдонимы: info boolean	Если `True` возвращаются все подробности о найденных ресурсах Варианты: `false` ← (по умолчанию) `true`
organization string	Ограничение поиска ресурса по организации
params dictionary	Добавление параметров к вызову API, если необходимо Если не указано, дополнительные параметры не передаются
password string / обязательно	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
resource string / обязательно	Ресурс для поиска Установите недопустимый вариант, например, foo, чтобы увидеть все доступные варианты.
search string	Запрос поиска для использования Если None, возвращаются все ресурсы
server_url string / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
username string / обязательно	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примечания

Примечание

Некоторые ресурсы не поддерживают область видимости и будут возвращать ошибки, если вы передадите organization или неизвестные данные в params.

Примеры

- name: "Read a Setting"
  theforeman.foreman.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    resource: settings
    search: name = foreman_url
  register: result
- debug:
    var: result.resources[0].value

- name: "Read all Registries"
  theforeman.foreman.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    resource: registries
  register: result
- debug:
    var: item.name
  with_items: "{{ result.resources }}"

- name: "Read all Organizations with full details"
  theforeman.foreman.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    resource: organizations
    full_details: true
  register: result
- debug:
    var: result.resources

- name: Get all existing subscriptions for organization with id 1
  theforeman.foreman.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    resource: subscriptions
    params:
      organization_id: 1
  register: result
- debug:
    var: result

- name: Get all existing activation keys for organization ACME
  theforeman.foreman.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    resource: activation_keys
    organization: ACME
  register: result
- debug:
    var: result

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

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

Ключ	Описание
resources list / elements=string	Информация о ресурсе Возвращается: всегда

Авторы

Sean O’Keeffe (@sean797)

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

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