Spec-Zone.ru › Ansible

dellemc.openmanage.idrac_network_attributes модуль — Настройка атрибутов сети iDRAC

Примечание

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

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

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

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

Впервые в dellemc.openmanage 8.4.0

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

Обзор

  • Этот модуль позволяет настраивать атрибуты порта и раздела сети на сетевых адаптерах.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

apply_time

строка / обязательно

Время применения атрибутов сети network_attributes и oem_network_attributes.

Это применимо только к network_attributes и oem_network_attributes.

Immediate позволяет пользователю немедленно перезагрузить хост и применить изменения. Применимо job_wait. Это применимо для oem_network_attributes и job_wait.

OnReset позволяет пользователю применить изменения при следующей перезагрузке хост-сервера.

AtMaintenanceWindowStart позволяет пользователю применить изменения в начале окна обслуживания, как указано в maintenance_window. Запланирована работа по перезагрузке.

InMaintenanceWindowOnReset позволяет применить изменения после ручного сброса, но в рамках окна обслуживания, как указано в maintenance_window.

Это не применимо для iDRAC8, значение будет проигнорировано и не повлияет на настройку oem_network_attributes.

Варианты:

  • "Immediate"
  • "OnReset"
  • "AtMaintenanceWindowStart"
  • "InMaintenanceWindowOnReset"

ca_path

путь

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

Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.

clear_pending

логическое

Этот параметр позволяет очистить все ожидающие изменения атрибутов сети OEM.

false не выполняет никаких операций.

true отбрасывает любые ожидающие изменения атрибутов сети или, если работа запланирована, удаляет работу.

Значение apply_time будет проигнорировано и не повлияет на операцию clear_pending.

Эта операция не поддерживается для iDRAC8.

Варианты:

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

idrac_ip

строка / обязательно

IP-адрес iDRAC.

idrac_password

псевдонимы: idrac_pwd

строка

Пароль пользователя iDRAC.

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

Пример: export IDRAC_PASSWORD=password

idrac_port

целое число

Порт iDRAC.

По умолчанию: 443

idrac_user

строка

Имя пользователя iDRAC.

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

Пример: export IDRAC_USERNAME=username

job_wait

логическое

Предоставляет возможность ожидания завершения задачи.

Это применимо, когда apply_time равно Immediate для oem_network_attributes.

Варианты:

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

job_wait_timeout

целое число

Максимальное время ожидания job_wait в секундах. Задача отслеживается только в течение этого времени.

Этот параметр применим, когда job_wait равно true.

По умолчанию: 1200

maintenance_window

словарь

Этот параметр позволяет планировать окно обслуживания.

Это необходимо, когда apply_time равно AtMaintenanceWindowStart или InMaintenanceWindowOnReset.

duration

целое число / обязательно

Длительность окна обслуживания в секундах.

start_time

строка / обязательно

Время начала планируемого окна обслуживания.

Формат: ГГГГ-ММ-ДДТчч:мм:сс<смещение>

<смещение> — это смещение от UTC текущего часового пояса, установленного в iDRAC в формате: +05:30 для IST.

network_adapter_id

строка / обязательно

Полное имя (FQDN) сетевого адаптера, представляющего физический сетевой адаптер, способный подключаться к компьютерной сети.

Пример FQDN сетевого адаптера: ‘NIC.Mezzanine.1A’

network_attributes

словарь

Словарь атрибутов сети и их значений. Чтобы просмотреть список атрибутов и их структуру, см. API ниже https://I(idrac_ip/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/<network_adapter_id>/NetworkDeviceFunctions/ <network_device_function_id>/Settings) и https://<idrac_ip>/redfish/v1/Schemas/NetworkDeviceFunction.v1_8_0.json.

network_attributes взаимоисключает oem_network_attributes.

network_device_function_id

строка / обязательно

Полное имя (FQDN) функции устройства сетевого адаптера, которая представляет логический интерфейс, предоставляемый сетевым адаптером.

Пример FQDN функции устройства сетевого адаптера: ‘NIC.Mezzanine.1A-1-1’
END_OF_DOCUMENT_MARKER

oem_network_attributes

словарь

Атрибуты должны быть частью реестра атрибутов интегрированного контроллера удаленного доступа Dell. Чтобы просмотреть список атрибутов в реестре атрибутов для iDRAC9 и более новых версий. Для получения дополнительной информации см. https://I(idrac_ip/redfish/v1/Chassis/System.Embedded.1/NetworkAdapters/<network_adapter_id>/NetworkDeviceFunctions/ <network_device_function_id>/Oem/Dell/DellNetworkAttributes/<network_device_function_id>) и https://I(idrac_ip/redfish/v1/Registries/NetworkAttributesRegistry_<network_device_function_id>/ NetworkAttributesRegistry_network_port_id.json).

Для серверов на базе iDRAC8 выведите имя атрибута сети из профиля конфигурации сервера.

oem_network_attributes взаимоисключающее с network_attributes.

resource_id

строка

Идентификатор ресурса.

Если значение для идентификатора ресурса не указано, модуль выбирает первый доступный идентификатор ресурса из списка системных ресурсов, возвращаемых iDRAC.

timeout

целое число

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

Тайм-аут уровня сокета в секундах.

По умолчанию: 30

validate_certs

булево

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

Если false, сертификаты SSL не будут проверены.

Настройте false только на сайтах, контролируемых лично, где используются самозаверяющие сертификаты.

До версии коллекции 5.0.0, validate_certs false по умолчанию.

Варианты:

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

x_auth_token

строка

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

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

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

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

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

Примеры

---
- name: Configure OEM network attributes
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: "NIC.Integrated.1"
    network_device_function_id: "NIC.Integrated.1-1-1"
    apply_time: "Immediate"
    oem_network_attributes:
      BannerMessageTimeout: "4"

- name: Configure OEM network attributes to apply on reset
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    oem_network_attributes:
      BannerMessageTimeout: "4"
    apply_time: OnReset

- name: Configure OEM network attributes to apply at maintainance window
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    oem_network_attributes:
      BannerMessageTimeout: "4"
    apply_time: AtMaintenanceWindowStart
    maintenance_window:
      start_time: "2022-09-30T05:15:40-05:00"
      duration: 600

- name: Clearing the pending attributes
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    apply_time: "Immediate"
    clear_pending: true

- name: Clearing the OEM pending attributes and apply the OEM network attributes
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    apply_time: "Immediate"
    clear_pending: true
    oem_network_attributes:
      BannerMessageTimeout: "4"

- name: Configure OEM network attributes and wait for the job
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    apply_time: "Immediate"
    oem_network_attributes:
      LnkSpeed: "10MbpsHalf"
      WakeOnLan: "Enabled"
      VLanMode: "Enabled"
    job_wait: true
    job_wait_timeout: 2000

- name: Configure redfish network attributes to update fiber channel on reset
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    apply_time: OnReset
    network_attributes:
      Ethernet:
        VLAN:
          VLANEnable: true

- name: Configure redfish network attributes to apply on reset
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    network_attributes:
      Ethernet:
        VLAN:
          VLANEnable: true
    apply_time: OnReset

- name: Configure redfish network attributes of iscsi to apply at maintainance window start
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    network_attributes:
      iSCSIBoot:
        InitiatorIPAddress: 1.0.0.1
    apply_time: AtMaintenanceWindowStart
    maintenance_window:
      start_time: "2022-09-30T05:15:40-05:00"
      duration: 600

- name: Configure redfish network attributes to apply at maintainance window on reset
  dellemc.openmanage.idrac_network_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    network_adapter_id: NIC.Integrated.1
    network_device_function_id: "NIC.Integrated.1-1-1"
    network_attributes:
      Ethernet:
        VLAN:
          VLANEnable: false
          VLANId: 1
    apply_time: AtMaintenanceWindowStart
    maintenance_window:
      start_time: "2022-09-30T05:15:40-05:00"
      duration: 600

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

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

Ключ

Описание

error_info

словарь

Подробности HTTP-ошибки.

Возвращается: при ошибке HTTP

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

invalid_attributes

словарь

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

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

Пример: {"IscsiInitiatorIpAddr": "Attribute is not valid.", "IscsiInitiatorSubnet": "Attribute is not valid."}

job_status

словарь

Возвращает вывод о состоянии задания.

Возвращается: всегда

Пример: {"ActualRunningStartTime": null, "ActualRunningStopTime": null, "CompletionTime": null, "Description": "Job Instance", "EndTime": "TIME_NA", "Id": "JID_XXXXXXXXX", "JobState": "Scheduled", "JobType": "NICConfiguration", "Message": "Task successfully scheduled.", "MessageArgs": [], "MessageId": "JCP001", "Name": "Configure: NIC.Integrated.1-1-1", "PercentComplete": 0, "StartTime": "2023-08-07T06:21:24", "TargetSettingsURI": null}

msg

строка

Статус операции обновления атрибута.

Возвращается: при применении атрибутов сети

Пример: "Successfully updated the network attributes."

Авторы

  • Abhishek Sinha(@ABHISHEK-SINHA10)

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

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

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

Spec-Zone.ru

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