dellemc.openmanage.idrac_license модуль – Настройка лицензий iDRAC

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: dellemc.openmanage.idrac_license.

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

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

Описание

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

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для валидации.
delete логическое значение	Удалить лицензию с iDRAC. Если delete `true`, то license_id обязателен. delete взаимоисключительно с export и import. Варианты: `false` ← (по умолчанию) `true`
export логическое значение	Экспортировать лицензию с iDRAC. Если export `true`, то license_id и share_parameters обязательны. export взаимоисключительно с delete и import. Варианты: `false` ← (по умолчанию) `true`
idrac_ip строка / обязательно	IP-адрес iDRAC.
idrac_password алиасы: idrac_pwd строка	Пароль пользователя iDRAC. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=password
idrac_port целое число	Порт iDRAC. По умолчанию: `443`
idrac_user строка	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=username
import логическое значение	Импортировать лицензию с iDRAC. Если import `true`, то share_parameters обязателен. import взаимоисключительно с delete и export. Варианты: `false` ← (по умолчанию) `true`
license_id алиасы: entitlement_id строка	Идентификатор лицензии, который необходимо импортировать, экспортировать или удалить. license_id обязателен, если delete `true` или export `true`.
resource_id строка	Идентификатор ресурса. Если значение идентификатора ресурса не указано, модуль выбирает первый доступный идентификатор ресурса из списка системных ресурсов, возвращенных iDRAC.
share_parameters словарь	Параметры, необходимые для импорта и экспорта лицензии. share_parameters обязателен, если export или import `true`.
file_name строка	Имя файла лицензии для операции import и export. file_name обязателен, если import `true`. Для операции import, когда share_type `local`, поддерживаемые расширения для file_name — ‘.txt’ и ‘.xml’. Для других типов share_type поддерживается расширение ‘.xml’
ignore_certificate_warning строка	Игнорирует предупреждение о сертификате при подключении к Share и применимо только когда share_type `https`. `on` игнорирует предупреждение о сертификате. `off` не игнорирует предупреждение о сертификате. Варианты: `"off"` ← (по умолчанию) `"on"`
ip_address строка	IP-адрес сетевого ресурса. ip_address обязателен, когда share_type `nfs`, `cifs`, `http` или `https`.
password строка	Пароль сетевого ресурса. password обязателен, когда share_type `cifs`.
proxy_password строка	Пароль прокси-сервера. proxy_password применим только когда share_type `https` или `https` и когда proxy_support `parameters_proxy`.
proxy_port целое число	Порт прокси-сервера. proxy_port применим только когда share_type `https` или `https` и когда proxy_support `parameters_proxy`. По умолчанию: `80`

END_OF_DOCUMENT_MARKER

proxy_server string	IP-адрес прокси-сервера. proxy_server требуется, когда proxy_support равен `parameters_proxy`. proxy_server применим только тогда, когда share_type равен `https` или `https` и когда proxy_support равен `parameters_proxy`.
proxy_support string	Указывает, используется ли прокси или нет. `off` не использует настройки прокси. `default_proxy` использует стандартные настройки прокси. `parameters_proxy` использует указанные настройки прокси. proxy_server требуется, когда proxy_support равен `parameters_proxy`. proxy_support применим только тогда, когда share_type равен `https` или `https`. Варианты: `"off"` ← (по умолчанию) `"default_proxy"` `"parameters_proxy"`
proxy_type string	Тип прокси-сервера. `http` для выбора HTTP-прокси. `socks` для выбора SOCKS-прокси. proxy_type применим только тогда, когда share_type равен `https` или `https` и когда proxy_support равен `parameters_proxy`. Варианты: `"http"` ← (по умолчанию) `"socks"`
proxy_username string	Имя пользователя прокси-сервера. proxy_username применим только тогда, когда share_type равен `https` или `https` и когда proxy_support равен `parameters_proxy`.
share_name string	Сеть или локальный путь к файлу лицензии.
share_type string	Тип сетевого ресурса. `local` использует локальный путь для операций import и export. `nfs` использует NFS-ресурс для операций import и export. `cifs` использует CIFS-ресурс для операций import и export. `http` использует HTTP-ресурс для операций import и export. `https` использует HTTPS-ресурс для операций import и export. Варианты: `"local"` ← (по умолчанию) `"nfs"` `"cifs"` `"http"` `"https"`
username string	Имя пользователя сетевого ресурса. username требуется, когда share_type равен `cifs`.
workgroup string	Рабочая группа сетевого ресурса. workgroup применим только при share_type равном `cifs`.
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

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к Dell iDRAC.
Этот модуль поддерживает только iDRAC9 и выше.
Этот модуль поддерживает IPv4 и IPv6 адреса.
Этот модуль не поддерживает check_mode.
Когда share_type равен local для операций import и export, данные о задаче не отображаются.

Примеры

---
- name: Export a license from iDRAC to local
  dellemc.openmanage.idrac_license:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENSE_123"
    export: true
    share_parameters:
      share_type: "local"
      share_name: "/path/to/share"
      file_name: "license_file"

- name: Export a license from iDRAC to NFS share
  dellemc.openmanage.idrac_license:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENSE_123"
    export: true
    share_parameters:
      share_type: "nfs"
      share_name: "/path/to/share"
      file_name: "license_file"
      ip_address: "192.168.0.1"

- name: Export a license from iDRAC to CIFS share
  dellemc.openmanage.idrac_license:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENSE_123"
    export: true
    share_parameters:
      share_type: "cifs"
      share_name: "/path/to/share"
      file_name: "license_file"
      ip_address: "192.168.0.1"
      username: "username"
      password: "password"
      workgroup: "workgroup"

- name: Export a license from iDRAC to HTTP share via proxy
  dellemc.openmanage.idrac_license:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENSE_123"
    export: true
    share_parameters:
      share_type: "http"
      share_name: "/path/to/share"
      file_name: "license_file"
      ip_address: "192.168.0.1"
      username: "username"
      password: "password"
      proxy_support: "parameters_proxy"
      proxy_type: socks
      proxy_server: "192.168.0.2"
      proxy_port: 1080
      proxy_username: "proxy_username"
      proxy_password: "proxy_password"

- name: Export a license from iDRAC to HTTPS share
  dellemc.openmanage.idrac_license:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENSE_123"
    export: true
    share_parameters:
      share_type: "https"
      share_name: "/path/to/share"
      file_name: "license_file"
      ip_address: "192.168.0.1"
      username: "username"
      password: "password"
      ignore_certificate_warning: "on"

- name: Import a license to iDRAC from local
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    import: true
    share_parameters:
      file_name: "license_file_name.xml"
      share_type: local
      share_name: "/path/to/share"

- name: Import a license to iDRAC from NFS share
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    import: true
    share_parameters:
      file_name: "license_file_name.xml"
      share_type: nfs
      ip_address: "192.168.0.1"
      share_name: "/path/to/share"

- name: Import a license to iDRAC from CIFS share
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    import: true
    share_parameters:
      file_name: "license_file_name.xml"
      share_type: cifs
      ip_address: "192.168.0.1"
      share_name: "/path/to/share"
      username: "username"
      password: "password"

- name: Import a license to iDRAC from HTTP share
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    import: true
    share_parameters:
      file_name: "license_file_name.xml"
      share_type: http
      ip_address: "192.168.0.1"
      share_name: "/path/to/share"
      username: "username"
      password: "password"

- name: Import a license to iDRAC from HTTPS share via proxy
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    import: true
    share_parameters:
      file_name: "license_file_name.xml"
      share_type: https
      ip_address: "192.168.0.1"
      share_name: "/path/to/share"
      username: "username"
      password: "password"
      proxy_support: "parameters_proxy"
      proxy_server: "192.168.0.2"
      proxy_port: 808
      proxy_username: "proxy_username"
      proxy_password: "proxy_password"

- name: Delete a License from iDRAC
  dellemc.openmanage.idrac_license:
    idrac_ip: 198.162.0.1
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "/path/to/ca_cert.pem"
    license_id: "LICENCE_123"
    delete: true

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

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

Ключ	Описание
error_info словарь	Детали HTTP-ошибки. Возвращается: при HTTP-ошибке Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "The authentication credentials included with this request are missing or invalid.", "MessageArgs": [], "MessageId": "Base.1.8.AccessDenied", "RelatedProperties": [], "Resolution": "Attempt to ensure that the URI is correct and that the service has the appropriate credentials.", "Severity": "Critical"}], "code": "Base.1.8.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
job_details словарь	Возвращает выходные данные для статуса задачи. Возвращается: для операций импорта и экспорта Пример: `{"ActualRunningStartTime": "2024-01-09T05:16:19", "ActualRunningStopTime": "2024-01-09T05:16:19", "CompletionTime": "2024-01-09T05:16:19", "Description": "Job Instance", "EndTime": null, "Id": "JID_XXXXXXXXX", "JobState": "Completed", "JobType": "LicenseExport", "Message": "The command was successful.", "MessageArgs": [], "MessageId": "LIC900", "Name": "Export: License", "PercentComplete": 100, "StartTime": "2024-01-09T05:16:19", "TargetSettingsURI": null}`
msg строка	Статус операции с лицензией. Возвращается: всегда Пример: `"Successfully exported the license."`

Авторы

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_license_module.html