Модуль dellemc.openmanage.idrac_server_config_profile — экспорт или импорт профиля конфигурации сервера iDRAC (SCP)
Примечание
Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 добавлено в dellemc.openmanage 5.0.0 | Файл Privacy Enhanced Mail (PEM), содержащий сертификат ЦС для проверки. |
command string | Если Если Если
Варианты:
|
end_host_power_state string | Этот параметр применим к команде Если Если Варианты:
|
export_format string | Укажите формат выходного файла. Этот параметр применим к команде Формат файла экспорта по умолчанию всегда XML, если значение command — Варианты:
|
export_use string добавлено в dellemc.openmanage 7.3.0 | Укажите тип экспортируемого профиля конфигурации сервера (SCP). Этот параметр применим, если значение command —
Варианты:
|
idrac_ip string / обязательный | IP-адрес iDRAC. |
idrac_password псевдонимы: idrac_pwd string | Пароль пользователя iDRAC. Если пароль не указан, используется переменная среды Пример: export IDRAC_PASSWORD=password |
idrac_port integer | Порт iDRAC. По умолчанию: |
idrac_user string | Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды Пример: export IDRAC_USERNAME=username |
ignore_certificate_warning string добавлено в dellemc.openmanage 7.3.0 | Если Если ignore_certificate_warning учитывается только в случае, если share_name имеет тип HTTPS, и поддерживается только на iDRAC9. Варианты:
|
import_buffer string добавлено в dellemc.openmanage 7.3.0 | Используется для импорта буфера XML или JSON в iDRAC. Если значение command — Этот параметр применим, если значение command — import_buffer нельзя использовать одновременно с share_name. |
include_in_export string добавлено в dellemc.openmanage 7.3.0 | Этот параметр применим, если значение command — Если Если Если Если Варианты:
|
job_wait boolean / обязательный | Ожидать ли завершения задания. Варианты:
|
job_wait_timeout integer | Максимальное время ожидания для job_wait в секундах. Отслеживание задания выполняется только в течение этого времени. Этот параметр применим, если значение job_wait — По умолчанию: |
proxy_password string добавлено в dellemc.openmanage 7.3.0 | Пароль для аутентификации на прокси-сервере. proxy_password учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. |
proxy_port string добавлено в dellemc.openmanage 7.3.0 | Порт прокси-сервера для аутентификации. proxy_port требуется, если share_name имеет тип HTTPS или HTTP, а значение proxy_support — proxy_port учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. По умолчанию: |
proxy_server string добавлено в dellemc.openmanage 7.3.0 | proxy_server требуется, если share_name имеет тип HTTPS или HTTP, а значение proxy_support — proxy_server учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. |
proxy_support boolean добавлено в dellemc.openmanage 7.3.0 | Включение или отключение прокси-сервера. proxy_support учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. Варианты:
|
proxy_type string добавлено в dellemc.openmanage 7.3.0 |
proxy_type учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. Варианты:
|
proxy_username string добавлено в dellemc.openmanage 7.3.0 | Имя пользователя для аутентификации на прокси-сервере. proxy_username учитывается только в случае, если share_name имеет тип HTTP или HTTPS, и поддерживается только на iDRAC9. |
scp_components псевдонимы: target list / элементы=string | Если Если Если Если Если Если Если Если Если Если Если Если Если Если значение command — Варианты:
По умолчанию: |
scp_file string | Имя файла профиля конфигурации сервера (SCP). Если значение command — Если для Если для |
string | Сетевая общая папка или локальный путь. Поддерживаются сетевые общие папки CIFS, NFS, HTTP и HTTPS. share_name нельзя использовать одновременно с import_buffer. Если значение command — |
псевдонимы: share_pwd string | Пароль пользователя сетевой общей папки. Этот параметр обязателен для сетевой общей папки CIFS. |
string | Имя пользователя сетевой общей папки в формате ‘user@domain’ или ‘domain\\user’, если пользователь входит в домен, иначе ‘user’. Этот параметр обязателен для сетевой общей папки CIFS. |
shutdown_type string | Этот параметр применим к команде Если Если Если Варианты:
|
timeout integer добавлено в dellemc.openmanage 5.0.0 | Тайм-аут на уровне сокета в секундах. По умолчанию: |
validate_certs boolean добавлено в dellemc.openmanage 5.0.0 | Если Настраивайте В версиях коллекции до Варианты:
|
x_auth_token string добавлено в dellemc.openmanage 9.3.0 | Токен аутентификации. Если x_auth_token не указан, используется переменная среды Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Примечания
Примечание
- Для работы с idrac_user этому модулю требуются привилегии «Administrator».
- Запускайте этот модуль в системе, имеющей прямой доступ к Dell iDRAC.
- Этот модуль поддерживает
check_mode. - Для импорта профиля конфигурации сервера (SCP) на серверах на базе iDRAC8 требуется лицензия iDRAC Enterprise или более поздняя версия.
- Для операции
importпараметрcheck_modeподдерживается только при значении targetALL. - Этот модуль поддерживает адреса 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 dictionary | Подробная информация об ошибке HTTP. Возвращается: при ошибке HTTP Пример: |
msg string | Состояние задания импорта или экспорта SCP. Возвращается: всегда Пример: |
scp_status dictionary | Сведения о задании операции SCP и ее ходе выполнения, полученные от iDRAC. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/idrac_server_config_profile_module.html