Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

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

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

delete

boolean

Удалить лицензию из iDRAC.

Если значение delete равно true, необходимо указать license_id.

Параметр delete несовместим с параметрами export и import.

Допустимые значения:

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

export

boolean

Экспортировать лицензию из iDRAC.

Если значение export равно true, необходимо указать license_id и share_parameters.

Параметр export несовместим с параметрами delete и import.

Допустимые значения:

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

idrac_ip

string / обязательный

IP-адрес iDRAC.

idrac_password

псевдонимы: 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

import

boolean

Импортировать лицензию в iDRAC.

Если значение import равно true, необходимо указать share_parameters.

Параметр import несовместим с параметрами delete и export.

Допустимые значения:

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

license_id

псевдонимы: entitlement_id

string

Идентификатор права на лицензию, которую необходимо импортировать, экспортировать или удалить.

Параметр license_id обязателен, если delete равно true или export равно true.

resource_id

string

Идентификатор ресурса.

Если идентификатор ресурса не указан, модуль выбирает первый доступный идентификатор из списка системных ресурсов, возвращаемого iDRAC.

share_parameters

dictionary

Параметры, необходимые для импорта и экспорта лицензии.

Параметр share_parameters обязателен, если export или import равно true.

file_name

string

Имя файла лицензии для операции import или export.

Параметр file_name обязателен, если import равно true.

Для операции import, если share_type равно local, для file_name поддерживаются расширения «.txt» и «.xml». Для остальных типов ресурсов поддерживается расширение «.xml».

ignore_certificate_warning

string

Игнорировать предупреждение о сертификате при подключении к общему ресурсу. Применимо только если share_type равно https.

on игнорирует предупреждение о сертификате.

off не игнорирует предупреждение о сертификате.

Допустимые значения:

  • "off" ← (по умолчанию)
  • "on"

ip_address

string

IP-адрес сетевого ресурса.

Параметр ip_address обязателен, если share_type равно nfs, cifs, http или https.

password

string

Пароль сетевого ресурса.

Параметр password обязателен, если share_type равно cifs.

proxy_password

string

Пароль прокси-сервера.

Параметр proxy_password применим только если share_type равно https или https, а proxy_support равно parameters_proxy.

proxy_port

integer

Порт прокси-сервера.

Параметр proxy_port применим только если share_type равно https или https, а proxy_support равно parameters_proxy.

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

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.
  • Если для операций import и export параметр share_type имеет значение local, сведения о задании не отображаются.
  • Из-за ограничений API параметры прокси-сервера игнорируются во время операции import.

Примеры

---
- 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: 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

dictionary

Сведения об ошибке 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

dictionary

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

Возвращается: для операций импорта и экспорта

Пример: {"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

string

Состояние операции с лицензией.

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

Пример: "Successfully exported the license."

Авторы

  • Rajshekar P(@rajshekarp87)
  • Akash Shendge(@shenda1)

Ссылки на коллекцию

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

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

Spec-Zone.ru

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