Spec-Zone.ru › Ansible

Модуль theforeman.foreman.subscription_info — получение информации о подписках

Примечание

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

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

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

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

Добавлено в theforeman.foreman 2.1.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

Используемый поисковый запрос

Если значение равно None и параметр 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 subscription"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Red Hat Satellite Infrastructure Subscription"

- name: "Show all subscriptions with a certain name"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: name="Red Hat Satellite Infrastructure Subscription"

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

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

Ключ

Описание

subscription

dictionary

Подробная информация о найденной подписке

Возвращается: при успешном выполнении, если был передан параметр name

subscriptions

list / элементы=dictionary

Список всех найденных подписок и сведения о них

Возвращается: при успешном выполнении, если был передан параметр search

Авторы

  • Evgeni Golov (@evgeni)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API