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

Примечание

Этот плагин входит в состав коллекции theforeman.foreman (версия 1.5.1).

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

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

Новое в версии 1.0.0: из theforeman.foreman

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

Описание

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

Требования

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

requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
full_details boolean	Варианты: нет ← да	Если `True` возвращаются все детали о найденных ресурсах псевдонимы: info
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`.

Примечания

Примечание

Некоторые ресурсы не поддерживают ограничение по области и вернут ошибки при передаче 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/resource_info_module.html