Spec-Zone.ru › Ansible

dellemc.openmanage.idrac_reset модуль — Сброс iDRAC до заводских настроек

Примечание

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

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

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

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

Новый в dellemc.openmanage 2.1.0

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

Описание

  • Этот модуль сбрасывает настройки iDRAC до заводских значений.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

custom_defaults_buffer

строка

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

Этот параметр предоставляет возможность импортировать входной буфер в формате XML в качестве пользовательской конфигурации по умолчанию.

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

custom_defaults_buffer взаимоисключает custom_defaults_file.

custom_defaults_file

строка

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

Имя файла пользовательской конфигурации по умолчанию в формате XML.

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

custom_defaults_file взаимоисключает custom_defaults_buffer.

default_password

строка

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

Этот параметр применяется только когда reset_to_default равен All или ResetAllWithRootDefaults.

Этот параметр необходим для отслеживания статуса жизненного цикла сервера после выполнения операции сброса. Если этот параметр не указан, статус жизненного цикла после сброса не отслеживается.

default_username

строка

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

Этот параметр применяется только когда reset_to_default равен All или ResetAllWithRootDefaults.

Этот параметр необходим для отслеживания статуса жизненного цикла сервера после выполнения операции сброса. Если этот параметр не указан, статус жизненного цикла после сброса не отслеживается.

force_reset

логический тип

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

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

Этот параметр применим только для iDRAC9.

Варианты:

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

idrac_ip

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

IP-адрес iDRAC.

idrac_password

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

строка

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

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

Пример: export IDRAC_PASSWORD=пароль

idrac_port

целое число

Порт iDRAC.

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

idrac_user

строка

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

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

Пример: export IDRAC_USERNAME=имя_пользователя

job_wait_timeout

целое число

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

Время в секундах ожидания завершения задачи.

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

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

reset_to_default

строка

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

Если значение не задано, по умолчанию iDRAC перезапускается.

All Удаляет все настройки и сбрасывает значения по умолчанию.

ResetAllWithRootDefaults Удаляет все настройки и сбрасывает имя пользователя по умолчанию до root, а пароль - до значения по умолчанию.

Default Удаляет все настройки, но сохраняет настройки пользователя и сети.

CustomDefaults Все настройки устанавливаются на значения по умолчанию. Этот параметр поддерживается для версий микропрограммного обеспечения 7.00.00.00 и более новых.

Варианты:

  • "Default"
  • "All"
  • "ResetAllWithRootDefaults"
  • "CustomDefaults"

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 ← (по умолчанию)

wait_for_idrac

логический тип

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

---
- name: Reset the iDRAC to default and do not wait till the iDRAC is accessible.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"
   reset_to_default: "Default"
   wait_for_idrac: false

- name: Reset the iDRAC to All and wait for lifecycle controller status to be ready.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"
   reset_to_default: "All"
   wait_for_idrac: true
   default_username: "user_name"
   default_password: "user_password"

- name: Force reset the iDRAC to default.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"
   reset_to_default: "Default"
   force_reset: true

- name: Gracefully restart the iDRAC.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"

- name: Reset the iDRAC to custom defaults XML and do not wait till the iDRAC is accessible.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"
   reset_to_default: "CustomDefaults"
   custom_defaults_file: "/path/to/custom_defaults.xml"

- name: Reset the iDRAC to custom defaults buffer input and do not wait till the iDRAC is accessible.
  dellemc.openmanage.idrac_reset:
   idrac_ip: "192.168.0.1"
   idrac_user: "user_name"
   idrac_password: "user_password"
   ca_path: "/path/to/ca_cert.pem"
   reset_to_default: "CustomDefaults"
   custom_defaults_buffer: "<SystemConfiguration Model=\"PowerEdge R7525\" ServiceTag=\"ABCD123\">\n<Component FQDD=\"iDRAC.Embedded.1\">\n
                               <Attribute Name=\"IPMILan.1#Enable\">Disabled</Attribute>\n </Component>\n\n</SystemConfiguration>"

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

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

Ключ

Описание

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

msg

строка

Статус операции сброса iDRAC.

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

Пример: "Successfully performed iDRAC reset."

reset_status

словарь

Подробности операции сброса iDRAC.

Возвращается: при запуске операции сброса.

Пример: {"idracreset": {"Data": {"StatusCode": 204}, "Message": "none", "Status": "Success", "StatusCode": 204, "retval": true}}

Авторы

  • Felix Stephen (@felixs88)
  • Anooja Vardhineni (@anooja-vardhineni)
  • Lovepreet Singh (@singh-lovepreet1)
  • 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_reset_module.html

Spec-Zone.ru

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