Модуль dellemc.openmanage.ome_device_network_services – Настройка сетевых служб шасси в OpenManage Enterprise Modular

Примечание

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

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

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

Для использования в плейбуке укажите: dellemc.openmanage.ome_device_network_services.

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

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

Описание

Этот модуль позволяет настраивать сетевые службы в OpenManage Enterprise Modular.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
device_id целое число	Идентификатор шасси, для которого необходимо обновить настройки. Если идентификатор устройства не указан, этот модуль обновляет настройки сетевых служб для hostname. device_id взаимоисключает device_service_tag.
device_service_tag строка	Тег службы шасси, для которого необходимо обновить настройку. Если тег службы устройства не указан, этот модуль обновляет настройки сетевых служб для hostname. device_service_tag взаимоисключает device_id.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise Modular. По умолчанию: `443`
remote_racadm_settings словарь	Настройки удаленной конфигурации RACADM.
enabled логическое / обязательно	Включает или отключает настройки удаленной конфигурации RACADM. Варианты: `false` `true`
snmp_settings словарь	Настройки конфигурации SNMP.
community_name строка	Строка сообщества SNMP. Требуется, когда enabled равен `true`.
enabled логическое / обязательно	Включает или отключает настройки SNMP. Варианты: `false` `true`
port_number целое число	Номер порта SNMP.
ssh_settings словарь	Настройки конфигурации SSH.
enabled логическое / обязательно	Включает или отключает настройки SSH. Варианты: `false` `true`
idle_timeout вещественное число	Таймаут бездействия SSH в минутах.
max_auth_retries целое число	Количество попыток повторного входа в систему SSH при неудачном подключении.
max_sessions целое число	Количество сеансов SSH.
port_number целое число	Номер порта для службы SSH.
timeout целое число добавлен в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя 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 по умолчанию.

Варианты:

false
true ← (по умолчанию)

x_auth_token

string

added in dellemc.openmanage 9.3.0

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

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

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

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

Примеры

---
- name: Update network services settings of a chassis using the device ID
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 25011
    snmp_settings:
      enabled: true
      port_number: 161
      community_name: public
    ssh_settings:
      enabled: false
    remote_racadm_settings:
      enabled: false

- name: Update network services settings of a chassis using the device service tag.
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.2"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: GHRT2RL
    snmp_settings:
      enabled: false
    ssh_settings:
      enabled: true
      port_number: 22
      max_sessions: 1
      max_auth_retries: 3
      idle_timeout: 1
    remote_racadm_settings:
      enabled: false

- name: Update network services settings of the host chassis.
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.3"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    snmp_settings:
      enabled: false
    ssh_settings:
      enabled: false
    remote_racadm_settings:
      enabled: true

Значения возврата

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

Ключ	Описание
error_info словарь	Подробности HTTP-ошибки. Возвращаемое значение: при HTTP-ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update the network configuration because the SNMP PortNumber is already in use.", "MessageArgs": ["SNMP PortNumber"], "MessageId": "CAPP1042", "RelatedProperties": [], "Resolution": "Enter a different port number and retry the operation.", "Severity": "Informational"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
msg строка	Общий статус настроек сетевых служб. Возвращаемое значение: всегда Пример: `"Successfully updated the network services settings."`
network_services_details словарь	Возвращается при успешном обновлении настроек сетевых служб. Возвращаемое значение: при успехе Пример: `{"EnableRemoteRacadm": true, "SettingType": "NetworkServices", "SnmpConfiguration": {"PortNumber": 161, "SnmpEnabled": true, "SnmpV1V2Credential": {"CommunityName": "public"}}, "SshConfiguration": {"IdleTimeout": 60, "MaxAuthRetries": 3, "MaxSessions": 1, "PortNumber": 22, "SshEnabled": false}}`

Авторы

Felix Stephen (@felixs88)

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

© 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_device_network_services_module.html