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 | Если Если Если
Варианты:
|
end_host_power_state string | Эта опция применима для команды Если Если Варианты:
|
export_format string | Укажите формат выходного файла. Эта опция применима для команды Формат экспортируемого файла по умолчанию всегда XML, когда command — Варианты:
|
export_use string added in dellemc.openmanage 7.3.0 | Укажите тип профиля конфигурации сервера (SCP), который необходимо экспортировать. Эта опция применима, когда command —
Варианты:
|
idrac_ip string / required | IP-адрес iDRAC. |
idrac_password aliases: idrac_pwd string | Пароль пользователя iDRAC. Если пароль не указан, используется переменная среды Пример: export IDRAC_PASSWORD=password |
idrac_port integer | Порт iDRAC. По умолчанию: |
idrac_user string | Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды Пример: export IDRAC_USERNAME=username |
ignore_certificate_warning string added in dellemc.openmanage 7.3.0 | Если Если ignore_certificate_warning учитывается только тогда, когда share_name имеет тип HTTPS и поддерживается только на iDRAC9. Варианты:
|
import_buffer string added in dellemc.openmanage 7.3.0 | Используется для импорта буферного ввода xml или json в iDRAC. Когда command — Эта опция применима, когда command — import_buffer является взаимоисключающим с share_name. |
include_in_export string added in dellemc.openmanage 7.3.0 | Эта опция применима, когда command — Если Если Если Если Варианты:
|
job_wait boolean / required | Ожидать ли завершения работы или нет. Варианты:
|
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 имеет значение proxy_port учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9. По умолчанию: |
proxy_server string added in dellemc.openmanage 7.3.0 | proxy_server требуется, когда share_name имеет тип HTTPS или HTTP, а proxy_support имеет значение proxy_server учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9. |
proxy_support boolean added in dellemc.openmanage 7.3.0 | Включить или отключить прокси. proxy_support учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9. Варианты:
|
proxy_type string added in dellemc.openmanage 7.3.0 |
proxy_type учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9. Варианты:
|
proxy_username string added in dellemc.openmanage 7.3.0 | Имя пользователя прокси для аутентификации. proxy_username учитывается только в том случае, когда share_name имеет тип HTTP или HTTPS и поддерживается только на iDRAC9. |
scp_components aliases: target list / elements=string | Если Если Если Если Если Если Если Если Если Если Если Если Если Когда command имеет значение Варианты:
По умолчанию: |
scp_file string | Имя файла профиля конфигурации сервера (SCP). Поддерживается только формат XML файла, когда command имеет значение Используется по умолчанию формат <idrac_ip>_YYmmdd_HHMMSS_scp, если этот параметр не указан для export_format используется, если для |
string | Сеть общего доступа или локальный путь. Поддерживаются типы сетевых ресурсов общего доступа CIFS, NFS, HTTP и HTTPS. share_name взаимоисключает import_buffer. Только “local” поддерживается, когда command имеет значение |
aliases: share_pwd string | Пароль пользователя для сетевой общего доступа. Этот параметр обязателен для сетевой общего доступа CIFS. |
string | Пользователь сетевой общего доступа в формате ‘user@domain’ или ‘domain\\user’, если пользователь является частью домена, иначе ‘user’. Этот параметр обязателен для сетевой общего доступа CIFS. |
shutdown_type string | Этот параметр применим для команды Если Если Если Варианты:
|
timeout integer added in dellemc.openmanage 5.0.0 | Таймаут уровня сокета в секундах. По умолчанию: |
validate_certs boolean added in dellemc.openmanage 5.0.0 | Если Настройка До версии сборки Варианты:
|
x_auth_token string added in dellemc.openmanage 9.3.0 | Токен аутентификации. Если 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 Пример: |
msg строка | Статус задачи импорта или экспорта профиля SCP. Возвращается: всегда Пример: |
scp_status словарь | Подробности задачи операции SCP и прогресса из iDRAC. Возвращается: успех Пример: |
Ссылки на сборку
© 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