Spec-Zone.ru › Ansible

dellemc.openmanage.ome_firmware_catalog модуль – Создание, изменение или удаление каталога микропрограммного обеспечения на OpenManage Enterprise или OpenManage Enterprise Modular

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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

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

catalog_description

строка

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

catalog_id

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

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

ID каталога.

Этот параметр взаимоисключающий с 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=пароль

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

string

added in dellemc.openmanage 3.4.0

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

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

Варианты:

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

timeout

integer

added in dellemc.openmanage 5.0.0

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

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

username

string

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

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

Пример: export OME_USERNAME=username

validate_certs

boolean

added in dellemc.openmanage 5.0.0

Если false, сертификаты SSL не будут проверены.

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

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

Варианты:

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

x_auth_token

string

added in 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)

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

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

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

Spec-Zone.ru

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