dellemc.openmanage.ome_application_network_proxy модуль — Обновляет конфигурацию прокси на OpenManage Enterprise

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 9.7.0).

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

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

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

Добавлен в dellemc.openmanage 2.1.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настроить сетевой прокси на OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path path added in dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, который будет использоваться для проверки.
enable_authentication boolean	Включить или отключить проверку подлинности прокси. Если enable_authentication имеет значение true, необходимо указать proxy_username и proxy_password. Если enable_authentication имеет значение false, имя пользователя и пароль прокси устанавливаются на значения по умолчанию. Choices: `false` `true`
enable_proxy boolean / required	Включает или отключает конфигурацию HTTP-прокси. Если enable proxy имеет значение false, конфигурация HTTP-прокси устанавливается на значение по умолчанию. Choices: `false` `true`
hostname string / required	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
ignore_certificate_validation aliases: ssl_check_disabled boolean added in dellemc.openmanage 9.5.0	Этот параметр игнорирует встроенные проверки сертификатов, такие как те, которые используются для обновлений гарантии и каталога. `true` игнорирует проверку сертификата. `false` не игнорирует проверку сертификата. Choices: `false` ← (default) `true`
ip_address string	Адрес прокси-сервера. Этот параметр обязателен, когда enable_proxy имеет значение true.
password string	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port integer	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. Default: `443`
proxy_exclusion_list list / elements=string added in dellemc.openmanage 9.5.0	Список IPv4-адресов, IPv6-адресов или доменных имен устройств, которые могут обходить прокси-сервер для прямого доступа к устройству.
proxy_password string	Пароль прокси-сервера. Этот параметр обязателен, когда enable_authentication имеет значение true.
proxy_port integer	Номер порта прокси-сервера. Этот параметр обязателен, когда enable_proxy имеет значение true.
proxy_username string	Имя пользователя прокси-сервера. Этот параметр обязателен, когда enable_authentication имеет значение true.
timeout integer added in dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. Default: `30`
update_password boolean added in dellemc.openmanage 9.5.0	Этот флаг используется для обновления proxy_password. Это применимо только тогда, когда enable_authentication имеет значение `true`. `true` обновит proxy_password. `false` не будет обновлять proxy_password. Choices: `false` ← (default) `true`
username string	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs boolean added in dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты проверяться не будут. Настраивайте `false` только на лично контролируемых сайтах, где используются самозаверяющие сертификаты. До версии коллекции `5.0.0`, validate_certs по умолчанию `false`. Choices: `false` `true` ← (default)

x_auth_token

строка

добавлен в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная окружения OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise.
Этот модуль поддерживает check_mode.
Этот модуль поддерживает IPv4 и IPv6 адреса.

Примеры

---
- name: Update proxy configuration and enable authentication
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: true
    proxy_username: "proxy_username"
    proxy_password: "proxy_password"

- name: Reset proxy authentication
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: false

- name: Reset proxy configuration
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: false

- name: Add IPv4, IPv6 and domain names of devices in proxy exclusion list
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    enable_authentication: false
    proxy_exclusion_list:
      - 192.168.1.0
      - 191.187.2.0
      - www.*.com
      - 191.1.168.1/24

- name: Clear the proxy exclusion list
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    proxy_exclusion_list: []

- name: Ignore the certificate validation
  dellemc.openmanage.ome_application_network_proxy:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_proxy: true
    ip_address: "192.168.0.2"
    proxy_port: 444
    ignore_certificate_validation: true

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

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

Ключ	Описание
error_info словарь	Подробная информация об ошибке HTTP. Возвращается: При ошибке HTTP Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because the input value for PortNumber is missing or an invalid value is entered.", "MessageArgs": ["PortNumber"], "MessageId": "CGEN6002", "RelatedProperties": [], "Resolution": "Enter a valid value and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Общий статус изменения конфигурации сетевого прокси-сервера. Возвращается: всегда Пример: `"Successfully updated network proxy configuration."`
proxy_configuration словарь	Обновленная конфигурация прокси-сервера для приложений. Возвращается: При успешной конфигурации сетевых настроек прокси-сервера Пример: `{"EnableAuthentication": true, "EnableProxy": true, "IpAddress": "192.168.0.2", "Password": null, "PortNumber": 444, "ProxyExclusionList": ["192.168.0.1", "www.*.com", "172.1.1.1/24"], "SslCheckDisabled": false, "Username": "root"}`

Авторы

Sajna Shetty(@Sajna-Shetty)
Rajshekar P(@rajshekarp87)

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

© 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/dellemc/openmanage/ome_application_network_proxy_module.html