Spec-Zone.ru › Ansible

dellemc.openmanage.idrac_server_config_profile модуль — Экспорт или импорт профиля конфигурации сервера iDRAC (SCP)

Примечание

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

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

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

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

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

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

Обзор

  • Экспортировать профиль конфигурации сервера (SCP) из iDRAC или импортировать из сетевой папки (CIFS, NFS, HTTP, HTTPS) или локального пути.

Требования

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

  • python >= 3.9.14

Параметры

Параметр

Комментарии

ca_path

path

added in dellemc.openmanage 5.0.0

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

command

string

Если import, модуль выполняет операцию импорта SCP.

Если export, модуль выполняет операцию экспорта SCP.

Если preview, модуль выполняет операцию предварительного просмотра SCP.

import_custom_defaults позволяет импортировать пользовательские настройки iDRAC по умолчанию.

export_custom_defaults позволяет экспортировать пользовательские настройки iDRAC по умолчанию.

import_custom_defaults и export_custom_defaults поддерживается только на iDRAC9 с прошивкой 7.00.00.00 и выше.

Варианты:

  • "import"
  • "export" ← (default)
  • "preview"
  • "import_custom_defaults"
  • "export_custom_defaults"

end_host_power_state

string

Эта опция применима для команды import.

Если On, конечное состояние питания хоста включено.

Если Off, конечное состояние питания хоста выключено.

Варианты:

  • "On" ← (default)
  • "Off"

export_format

string

Укажите формат выходного файла. Эта опция применима для команды export или export_custom_defaults.

Формат экспортируемого файла по умолчанию всегда XML, когда command — export_custom_defaults.

Варианты:

  • "JSON"
  • "XML" ← (default)

export_use

string

added in dellemc.openmanage 7.3.0

Укажите тип профиля конфигурации сервера (SCP), который необходимо экспортировать.

Эта опция применима, когда command — export.

Default Создает неразрушающий снимок конфигурации.

Replace Заменяет сервер другим или восстанавливает настройки серверов до известной базовой линии.

Clone Клонирует настройки с одного сервера на другой сервер с идентичной аппаратной конфигурацией. Все настройки, кроме идентификатора ввода/вывода, обновляются (например, будет сброшен RAID). Настройки в этом экспорте будут разрушительными при загрузке на другую систему.

Варианты:

  • "Default" ← (default)
  • "Clone"
  • "Replace"

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

ignore_certificate_warning

string

added in dellemc.openmanage 7.3.0

Если ignore, он игнорирует предупреждения о сертификате.

Если showerror, он показывает предупреждения о сертификате.

ignore_certificate_warning учитывается только тогда, когда share_name имеет тип HTTPS и поддерживается только на iDRAC9.

Варианты:

  • "ignore" ← (default)
  • "showerror"

import_buffer

string

added in dellemc.openmanage 7.3.0

Используется для импорта буферного ввода xml или json в iDRAC.

Когда command — import_custom_defaults, поддерживается только формат файла XML.

Эта опция применима, когда command — import или preview или import_custom_defaults.

import_buffer является взаимоисключающим с share_name.

include_in_export

string

added in dellemc.openmanage 7.3.0

Эта опция применима, когда command — export.

Если default, он экспортирует профиль конфигурации сервера по умолчанию.

Если readonly, он экспортирует SCP с атрибутами только для чтения.

Если passwordhashvalues, он экспортирует SCP с хэш-значениями паролей.

Если customtelemetry, экспортирует SCP с пользовательскими атрибутами телеметрии, поддерживаемыми только в iDRAC9.

Варианты:

  • "default" ← (default)
  • "readonly"
  • "passwordhashvalues"
  • "customtelemetry"

job_wait

boolean / required

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

Варианты:

  • false
  • true

proxy_password

string

added in dellemc.openmanage 7.3.0

Пароль прокси для аутентификации.

proxy_password учитывается только тогда, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

proxy_port

string

added in dellemc.openmanage 7.3.0

Порт прокси для аутентификации.

proxy_port требуется, когда share_name имеет тип HTTPS или HTTP, а proxy_support имеет значение true.

proxy_port учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

По умолчанию: "80"

proxy_server

string

added in dellemc.openmanage 7.3.0

proxy_server требуется, когда share_name имеет тип HTTPS или HTTP, а proxy_support имеет значение true.

proxy_server учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

proxy_support

boolean

added in dellemc.openmanage 7.3.0

Включить или отключить прокси.

proxy_support учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

Варианты:

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

proxy_type

string

added in dellemc.openmanage 7.3.0

http для выбора прокси типа HTTP.

socks4 для выбора прокси типа SOCKS4.

proxy_type учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

Варианты:

  • "http" ← (по умолчанию)
  • "socks4"

proxy_username

string

added in dellemc.openmanage 7.3.0

Имя пользователя прокси для аутентификации.

proxy_username учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9.

scp_components

aliases: target

list / elements=string

Если ALL, этот параметр экспортирует или импортирует конфигурации всех компонентов из файла SCP.

Если IDRAC, этот параметр экспортирует или импортирует конфигурацию iDRAC из файла SCP.

Если BIOS, этот параметр экспортирует или импортирует конфигурацию BIOS из файла SCP.

Если NIC, этот параметр экспортирует или импортирует конфигурацию сетевой карты из файла SCP.

Если RAID, этот параметр экспортирует или импортирует конфигурацию RAID из файла SCP.

Если FC, этот параметр экспортирует или импортирует конфигурации FiberChannel из файла SCP.

Если InfiniBand, этот параметр экспортирует или импортирует конфигурацию InfiniBand из файла SCP.

Если SupportAssist, этот параметр экспортирует или импортирует конфигурацию SupportAssist из файла SCP.

Если EventFilters, этот параметр экспортирует или импортирует конфигурацию EventFilters из файла SCP.

Если System, этот параметр экспортирует или импортирует системную конфигурацию из файла SCP.

Если LifecycleController, этот параметр экспортирует или импортирует конфигурацию SupportAssist из файла SCP.

Если AHCI, этот параметр экспортирует или импортирует конфигурацию EventFilters из файла SCP.

Если PCIeSSD, этот параметр экспортирует или импортирует конфигурацию PCIeSSD из файла SCP.

Когда command имеет значение export или import, target с несколькими компонентами поддерживается только на iDRAC9 с микропрограммой 6.10.00.00 и выше.

Варианты:

  • "ALL" ← (по умолчанию)
  • "IDRAC"
  • "BIOS"
  • "NIC"
  • "RAID"
  • "FC"
  • "InfiniBand"
  • "SupportAssist"
  • "EventFilters"
  • "System"
  • "LifecycleController"
  • "AHCI"
  • "PCIeSSD"

По умолчанию: ["ALL"]

scp_file

string

Имя файла профиля конфигурации сервера (SCP).

Поддерживается только формат XML файла, когда command имеет значение import или import_custom_defaults или export_custom_defaults.

Используется по умолчанию формат <idrac_ip>_YYmmdd_HHMMSS_scp, если этот параметр не указан для export или export_custom_defaults.

export_format используется, если для export не указан допустимый расширение файла.

share_name

string

Сеть общего доступа или локальный путь.

Поддерживаются типы сетевых ресурсов общего доступа CIFS, NFS, HTTP и HTTPS.

share_name взаимоисключает import_buffer.

Только “local” поддерживается, когда command имеет значение import_custom_defaults или export_custom_defaults.

share_password

aliases: share_pwd

string

Пароль пользователя для сетевой общего доступа. Этот параметр обязателен для сетевой общего доступа CIFS.

share_user

string

Пользователь сетевой общего доступа в формате ‘user@domain’ или ‘domain\\user’, если пользователь является частью домена, иначе ‘user’. Этот параметр обязателен для сетевой общего доступа CIFS.

shutdown_type

string

Этот параметр применим для команды import.

Если Graceful, задача вежливо выключает операционную систему и отключает сервер.

Если Forced, сервер отключается принудительно.

Если NoReboot, задача применения SCP будет приостановлена до вашего ручного перезапуска сервера.

Варианты:

  • "Graceful" ← (по умолчанию)
  • "Forced"
  • "NoReboot"

timeout

integer

added in dellemc.openmanage 5.0.0

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

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

END_OF_DOCUMENT_MARKER

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 не указан, используется переменная окружения IDRAC_X_AUTH_TOKEN.

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Для модуля требуется привилегия «Администратор» для idrac_user.
  • Запускайте этот модуль с системы, имеющей прямой доступ к Dell iDRAC.
  • Этот модуль поддерживает check_mode.
  • Для импорта профиля конфигурации сервера (SCP) на серверах на базе iDRAC8 серверы должны иметь лицензию iDRAC Enterprise или более позднюю.
  • Для операции import, check_mode поддерживается только когда target является ALL.
  • Этот модуль поддерживает адреса IPv4 и IPv6.

Примеры

---
- name: Export SCP with IDRAC components in JSON format to a local path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "/scp_folder"
    scp_components:
      - IDRAC
    scp_file: example_file
    export_format: JSON
    export_use: Clone
    job_wait: true

- name: Import SCP with IDRAC components in JSON format from a local path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "/scp_folder"
    command: import
    scp_components:
      - IDRAC
    scp_file: example_file.json
    shutdown_type: Graceful
    end_host_power_state: "On"
    job_wait: false

- name: Export SCP with BIOS components in XML format to a NFS share path with auto-generated file name
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "192.168.0.2:/share"
    scp_components:
      - BIOS
    export_format: XML
    export_use: Default
    job_wait: true

- name: Import SCP with BIOS components in XML format from a NFS share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "192.168.0.2:/share"
    command: import
    scp_components:
      - BIOS
    scp_file: 192.168.0.1_20210618_162856.xml
    shutdown_type: NoReboot
    end_host_power_state: "Off"
    job_wait: false

- name: Export SCP with RAID components in XML format to a CIFS share path with share user domain name
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "\\\\192.168.0.2\\share"
    share_user: share_username@domain
    share_password: share_password
    scp_file: example_file.xml
    scp_components:
      - RAID
    export_format: XML
    export_use: Default
    job_wait: true

- name: Import SCP with RAID components in XML format from a CIFS share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "\\\\192.168.0.2\\share"
    share_user: share_username
    share_password: share_password
    command: import
    scp_components:
      - RAID
    scp_file: example_file.xml
    shutdown_type: Forced
    end_host_power_state: "On"
    job_wait: true

- name: Export SCP with ALL components in JSON format to a HTTP share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "http://192.168.0.3/share"
    share_user: share_username
    share_password: share_password
    scp_file: example_file.json
    scp_components:
      - ALL
    export_format: JSON
    job_wait: false

- name: Import SCP with ALL components in JSON format from a HTTP share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: import
    share_name: "http://192.168.0.3/share"
    share_user: share_username
    share_password: share_password
    scp_file: example_file.json
    shutdown_type: Graceful
    end_host_power_state: "On"
    job_wait: true

- name: Export SCP with ALL components in XML format to a HTTPS share path without SCP file name
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "https://192.168.0.4/share"
    share_user: share_username
    share_password: share_password
    scp_components:
      - ALL
    export_format: XML
    export_use: Replace
    job_wait: true

- name: Import SCP with ALL components in XML format from a HTTPS share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: import
    share_name: "https://192.168.0.4/share"
    share_user: share_username
    share_password: share_password
    scp_file: 192.168.0.1_20160618_164647.xml
    shutdown_type: Graceful
    end_host_power_state: "On"
    job_wait: false

- name: Preview SCP with IDRAC components in XML format from a CIFS share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "\\\\192.168.0.2\\share"
    share_user: share_username
    share_password: share_password
    command: preview
    scp_components:
      - ALL
    scp_file: example_file.xml
    job_wait: true

- name: Preview SCP with IDRAC components in JSON format from a NFS share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "192.168.0.2:/share"
    command: preview
    scp_components:
      - IDRAC
    scp_file: example_file.xml
    job_wait: true

- name: Preview SCP with IDRAC components in XML format from a HTTP share path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "http://192.168.0.1/http-share"
    share_user: share_username
    share_password: share_password
    command: preview
    scp_components:
      - ALL
    scp_file: example_file.xml
    job_wait: true

- name: Preview SCP with IDRAC components in XML format from a local path
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    share_name: "/scp_folder"
    command: preview
    scp_components:
      - IDRAC
    scp_file: example_file.json
    job_wait: false

- name: Import SCP with IDRAC components in XML format from the XML content.
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: import
    scp_components:
      - IDRAC
    job_wait: true
    import_buffer: "<SystemConfiguration><Component FQDD='iDRAC.Embedded.1'><Attribute Name='IPMILan.1#Enable'>
      Disabled</Attribute></Component></SystemConfiguration>"

- name: Export SCP with ALL components in XML format using HTTP proxy.
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    scp_components:
      - ALL
    share_name: "http://192.168.0.1/http-share"
    proxy_support: true
    proxy_server: 192.168.0.5
    proxy_port: 8080
    proxy_username: proxy_username
    proxy_password: proxy_password
    proxy_type: http
    include_in_export: passwordhashvalues
    job_wait: true

- name: Import SCP with IDRAC and BIOS components in XML format using SOCKS4 proxy
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: import
    scp_components:
      - IDRAC
      - BIOS
    share_name: "https://192.168.0.1/http-share"
    proxy_support: true
    proxy_server: 192.168.0.6
    proxy_port: 8080
    proxy_type: socks4
    scp_file: filename.xml
    job_wait: true

- name: Import SCP with IDRAC components in JSON format from the JSON content.
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "{{ idrac_ip }}"
    idrac_user: "{{ idrac_user }}"
    idrac_password: "{{ idrac_password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: import
    scp_components:
      - IDRAC
    job_wait: true
    import_buffer: "{\"SystemConfiguration\": {\"Components\": [{\"FQDD\": \"iDRAC.Embedded.1\",\"Attributes\":
      [{\"Name\": \"SNMP.1#AgentCommunity\",\"Value\": \"public1\"}]}]}}"

- name: Export custom default
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    job_wait: true
    share_name: "/scp_folder"
    command: export_custom_defaults
    scp_file: example_file

- name: Import custom default
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    job_wait: true
    share_name: "/scp_folder"
    command: import_custom_defaults
    scp_file: example_file.xml

- name: Import custom default using buffer
  dellemc.openmanage.idrac_server_config_profile:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    job_wait: true
    command: import_custom_defaults
    import_buffer: "<SystemConfiguration><Component FQDD='iDRAC.Embedded.1'><Attribute Name='IPMILan.1#Enable'>Disabled</Attribute>
                  </Component></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

строка

Статус задачи импорта или экспорта профиля SCP.

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

Пример: "Successfully imported the Server Configuration Profile"

scp_status

словарь

Подробности задачи операции SCP и прогресса из iDRAC.

Возвращается: успех

Пример: {"Id": "JID_XXXXXXXXX", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.", "MessageArgs": [], "MessageId": "XXX123", "Name": "Import Configuration", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true}

Авторы

  • Jagadeesh N V(@jagadeeshnv)
  • Felix Stephen (@felixs88)
  • Jennifer John (@Jennifer-John)
  • Shivam Sharma (@ShivamSh3)
  • Lovepreet Singh (@singh-lovepreet1)

Ссылки на сборку

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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