Модуль theforeman.foreman.smart_proxy — управление смарт-прокси

Примечание

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

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

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

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

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

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

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

Создание, обновление и удаление смарт-прокси

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
download_policy string	Политика загрузки для смарт-прокси Доступно только для установок Katello. Политика загрузки `background` устарела и недоступна начиная с Katello 4.3. Политика загрузки `streamed` доступна начиная с Katello 4.5. Варианты: `"background"` `"immediate"` `"on_demand"` `"streamed"` `"inherit"`
lifecycle_environments list / elements=string	Среды жизненного цикла, синхронизируемые со смарт-прокси. Доступно только для установок Katello.
locations list / elements=string	Список местоположений, которым следует назначить сущность
name string / обязательный	Имя смарт-прокси
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / elements=string	Список организаций, которым следует назначить сущность
password string	Пароль пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_PASSWORD`.
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
url string / обязательный	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	Поддержка: full	Модуль может выполняться в режиме check_mode и возвращать прогноз изменения статуса без изменения сущности
diff_mode	Поддержка: full	В режиме diff_mode будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примечания

Примечание

Даже при state=present этот модуль не устанавливает новый смарт-прокси.
Он может только связать существующий смарт-прокси, доступный по указанному адресу url.
Для создания смарт-прокси рекомендуется использовать foreman-installer.

Примеры

# Create a local Smart Proxy
- name: "Create Smart Proxy"
  theforeman.foreman.smart_proxy:
    username: "admin"
    password: "changeme"
    server_url: "https://{{ ansible_fqdn }}"
    name: "{{ ansible_fqdn }}"
    url: "https://{{ ansible_fqdn }}:9090"
    download_policy: "immediate"
    lifecycle_environments:
      - "Development"
    organizations:
      - "Default Organization"
    locations:
      - "Default Location"
    state: present

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

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

Ключ	Описание
entity dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успехе
smart_proxies list / elements=dictionary	Список smart_proxies. Возвращается: при успехе

Авторы

James Stuart (@jstuart)
Matthias M Dellweg (@mdellweg)
Jeffrey van Pelt (@Thulium-Drake)

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

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