Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_firmware_catalog — создание, изменение или удаление каталога прошивок в OpenManage Enterprise или OpenManage Enterprise Modular

Примечание

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

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

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

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

Новое в dellemc.openmanage 2.0.0

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

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

  • Этот модуль позволяет создавать, изменять и удалять каталоги прошивок в OpenManage Enterprise или OpenManage Enterprise Modular.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

catalog_description

строка

Описание каталога.

catalog_id

список / элементы=целое число

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

Идентификатор каталога.

Этот параметр нельзя использовать одновременно с catalog_name.

Укажите список идентификаторов каталогов прошивок, поддерживаемых, когда state имеет значение absent.

catalog_name

список / элементы=строка

Имя создаваемого каталога прошивок.

Этот параметр нельзя использовать одновременно с catalog_id.

Укажите список имен каталогов прошивок, поддерживаемых, когда state имеет значение absent.

check_certificate

логическое значение

Предупреждения о сертификатах игнорируются, если для repository_type задано значение HTTPS. Если true. В противном случае предупреждения о сертификатах не игнорируются.

Варианты:

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

file_name

строка

Имя файла каталога, связанного с source_path.

Этот параметр игнорируется, если для repository_type задано значение DELL_ONLINE.

hostname

строка / обязательный

IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.

job_wait

логическое значение

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

Позволяет дождаться завершения задания.

Этот параметр применим, когда state имеет значение present.

Варианты:

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

job_wait_timeout

целое число

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

Максимальное время ожидания для job_wait в секундах. Отслеживание задания выполняется только в течение этого времени.

Этот параметр применим, когда job_wait имеет значение true.

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

new_catalog_name

строка

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

Новое имя каталога прошивок.

password

строка

Пароль OpenManage Enterprise или OpenManage Enterprise Modular.

Если пароль не указан, используется переменная среды OME_PASSWORD.

Пример: export OME_PASSWORD=password

port

целое число

HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular.

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

repository_domain

строка

Доменное имя репозитория.

Этот параметр игнорируется, если для repository_type задано значение DELL_ONLINE.

repository_password

строка

Пароль для доступа к репозиторию.

Этот параметр обязателен, если для repository_type задано значение CIFS.

Этот параметр игнорируется, если для repository_type задано значение DELL_ONLINE.

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

repository_type

строка

Тип репозитория. Поддерживаются следующие типы: NFS, CIFS, HTTP, HTTPS и DELL_ONLINE.

Варианты:

  • "NFS"
  • "CIFS"
  • "HTTP"
  • "HTTPS"
  • "DELL_ONLINE"

repository_username

строка

Имя пользователя репозитория, в котором хранится каталог.

Этот параметр обязателен, если для repository_type задано значение CIFS.

Этот параметр игнорируется, если для repository_type задано значение DELL_ONLINE.

source

строка

IP-адрес системы в локальной сети, в которой хранится каталог прошивок.

По умолчанию для этого параметра задается значение downloads.dell.com, если для repository_type задано значение DELL_ONLINE.

source_path

строка

Укажите полный путь к расположению файла каталога без имени файла.

Этот параметр игнорируется, если для repository_type задано значение DELL_ONLINE.

state

строка

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

present создает или изменяет каталог.

absent удаляет существующий каталог.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

целое число

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

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

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

username

строка

Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular.

Если имя пользователя не указано, используется переменная среды OME_USERNAME.

Пример: export OME_USERNAME=username

validate_certs

логическое значение

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

Если false, сертификаты SSL не проверяются.

Настраивайте false только на сайтах под личным контролем, где используются самоподписанные сертификаты.

До версии коллекции 5.0.0 значение validate_certs по умолчанию — false.

Варианты:

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

x_auth_token

строка

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

Токен аутентификации.

Если x_auth_token не указан, используется переменная среды OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Если указан repository_password, модуль всегда сообщает об изменении состояния.
  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise или OpenManage Enterprise Modular.
  • Этот модуль поддерживает адреса IPv4 и IPv6.
  • Этот модуль поддерживает check_mode.

Примеры

---
- name: Create a catalog from HTTPS repository
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "HTTPS"
    source: "downloads.dell.com"
    source_path: "catalog"
    file_name: "catalog.gz"
    check_certificate: true

- name: Create a catalog from HTTP repository
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "HTTP"
    source: "downloads.dell.com"
    source_path: "catalog"
    file_name: "catalog.gz"

- name: Create a catalog using CIFS share
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "CIFS"
    source: "192.167.0.1"
    source_path: "cifs/R940"
    file_name: "catalog.gz"
    repository_username: "repository_username"
    repository_password: "repository_password"
    repository_domain: "repository_domain"

- name: Create a catalog using NFS share
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "NFS"
    source: "192.166.0.2"
    source_path: "/nfs/R940"
    file_name: "catalog.xml"

- name: Create a catalog using repository from Dell.com
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "catalog_description"
    repository_type: "DELL_ONLINE"
    check_certificate: true

- name: Modify a catalog using a repository from CIFS share
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_name: "catalog_name"
    catalog_description: "new catalog_description"
    repository_type: "CIFS"
    source: "192.167.0.2"
    source_path: "cifs/R941"
    file_name: "catalog1.gz"
    repository_username: "repository_username"
    repository_password: "repository_password"
    repository_domain: "repository_domain"

- name: Modify a catalog using a repository from Dell.com
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    catalog_id: 10
    new_catalog_name: "new_catalog_name"
    repository_type: "DELL_ONLINE"
    catalog_description: "catalog_description"

- name: Delete catalog using catalog name
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    catalog_name: ["catalog_name1", "catalog_name2"]

- name: Delete catalog using catalog id
  dellemc.openmanage.ome_firmware_catalog:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    catalog_id: [11, 34]

Возвращаемые значения

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

Ключ

Описание

associated_baselines

список / элементы=словарь

Идентификаторы базовых конфигураций, связанных с каталогом.

Возвращается: когда state имеет значение absent

Пример: [{"BaselineId": 24, "BaselineName": "new"}, {"BaselineId": 25, "BaselineName": "c7"}, {"BaselineId": 27, "BaselineName": "c4"}]

catalog_id

целое число

Идентификаторы удаленного каталога.

Возвращается: когда state имеет значение absent

Пример: 10123

catalog_status

словарь

Сведения об операции с каталогом.

Возвращается: когда state имеет значение present

Пример: {"AssociatedBaselines": [], "BaseLocation": null, "BundlesCount": 0, "Filename": "catalog.gz", "Id": 12, "LastUpdated": null, "ManifestIdentifier": null, "ManifestVersion": null, "NextUpdate": null, "PredecessorIdentifier": null, "ReleaseDate": null, "ReleaseIdentifier": null, "Repository": {"CheckCertificate": true, "Description": "HTTPS Desc", "DomainName": null, "Id": null, "Name": "catalog4", "Password": null, "RepositoryType": "HTTPS", "Source": "company.com", "Username": null}, "Schedule": null, "SourcePath": "catalog", "Status": null, "TaskId": 10094}

error_info

словарь

Сведения об ошибке HTTP.

Возвращается: при ошибке HTTP

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to create or update the catalog because a repository with the same name already exists.", "Resolution": "Enter a different name and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

job_id

целое число

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

Возвращается: когда задание каталога выполняется

Пример: 10123

msg

строка

Общий статус операции с каталогом прошивок.

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

Пример: "Successfully triggered the job to create a catalog with Task ID : 10094"

Авторы

  • Sajna Shetty(@Sajna-Shetty)
  • Jagadeesh N V(@jagadeeshnv)
  • Krunal Thakkar(@Krunal-Thakkar)

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

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

© 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/ome_firmware_catalog_module.html

Spec-Zone.ru

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