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

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.

Для iDRAC10 поддерживается только OnReset.

Варианты:

• "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

логический

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

Применяется, если для oem_network_attributes параметр apply_time имеет значение Immediate.

Варианты:

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

job_wait_timeout

целое число

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

Этот параметр применяется, если job_wait имеет значение true.

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

maintenance_window

словарь

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

Обязателен, если параметр apply_time имеет значение AtMaintenanceWindowStart или InMaintenanceWindowOnReset.

duration

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

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

start_time

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

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

Формат: YYYY-MM-DDThh:mm:ss<offset>

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

network_adapter_id

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

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

Пример FQDD сетевого адаптера: ‘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

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

FQDD функции сетевого адаптера — устройства, представляющей логический интерфейс, предоставляемый сетевым адаптером.

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

oem_network_attributes

словарь

Атрибуты должны входить в реестр атрибутов Integrated Dell Remote Access Controller. Список атрибутов в реестре атрибутов для 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

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."