Spec-Zone.ru › Ansible

dellemc.openmanage.idrac_system_erase module – Erase system and storage components of the server

Примечание

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

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

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

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

Новое в dellemc.openmanage 9.7.0

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

Краткое описание

  • Этот модуль позволяет стереть компоненты системы, такие как iDRAC, BIOS, DIAG и так далее. Вы также можете стереть компоненты хранения, такие как кэш PERC NV, энергонезависимую память, криптографическое стирание физических дисков и так далее, на сервере.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

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

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

component

list / elements=string / required

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

Поддерживаются следующие компоненты: AllApps BIOS CryptographicErasePD DIAG DPU DrvPack IDRAC LCData NonVolatileMemory OverwritePD PERCNVCache ReinstallFW vFlash

idrac_ip

string / required

IP-адрес iDRAC.

idrac_password

aliases: idrac_pwd

string

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

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

Пример: export IDRAC_PASSWORD=password

idrac_port

integer

Порт iDRAC.

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

idrac_user

string

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

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

Пример: export IDRAC_USERNAME=username

job_wait

boolean

Ожидать завершения работы. Это применимо, когда power_on true.

true ожидает завершения работы.

false не ожидает завершения работы.

Варианты:

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

job_wait_timeout

integer

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

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

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

power_on

boolean

Этот параметр позволяет включить сервер после завершения операции стирания. Это применимо, когда job_wait true.

true включает сервер.

false не включает сервер.

Варианты:

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

resource_id

string

Идентификатор менеджера iDRAC.

timeout

integer

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

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

x_auth_token

string

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

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

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

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

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

diff_mode

Поддержка: отсутствует

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

Примечания

Примечание

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

Примеры

---
- name: Erase a single component and power on the server
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["BIOS"]
    power_on: true

- name: Erase multiple components and do not power on the server after the erase operation is completed
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["BIOS", "DIAG", "PERCNVCache"]

- name: Erase multiple components and do not wait for the job completion
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["IDRAC", "DPU", "LCData"]
    job_wait: false

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

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

Ключ

Описание

error_info

словарь

Подробная информация об ошибке HTTP.

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the value NonVolatileMemor entered for the property Component is not in the list of acceptable values.", "MessageArgs": ["NonVolatileMemor", "Component"], "MessageArgs@odata.count": 2, "MessageId": "IDRAC.2.9.SYS426", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Enter a valid value from the enumeration list that Redfish service supports and retry the operation.For information about valid values, see the iDRAC User's Guide available on the support site.", "Severity": "Warning"}, {"Message": "The value 'NonVolatileMemor' for the property Component is not in the list of acceptable values.", "MessageArgs": ["NonVolatileMemor", "Component"], "MessageArgs@odata.count": 2, "MessageId": "Base.1.12.PropertyValueNotInList", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed.", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}

job_details

словарь

Возвращает результат статуса задачи.

Возвращается: Для операции стирания системы

Пример: {"ActualRunningStartTime": null, "ActualRunningStopTime": null, "CompletionTime": "2024-08-06T19:55:01", "Description": "Job Instance", "EndTime": "TIME_NA", "Id": "JID_229917427823", "JobState": "Completed", "JobType": "SystemErase", "Message": "Job completed successfully.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "SYS018", "Name": "System_Erase", "PercentComplete": 100, "StartTime": "2024-08-06T19:49:02", "TargetSettingsURI": null}

msg

строка

Статус операции стирания компонента системы.

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

Пример: "Successfully completed the system erase operation."

Авторы

  • 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/idrac_system_erase_module.html

Spec-Zone.ru

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