Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_alert_policies_category_info — Получает информацию обо всех категориях политик оповещений OME.

Примечание

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

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

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

Для использования в плейбуке укажите: dellemc.openmanage.ome_alert_policies_category_info.

Новая функция в dellemc.openmanage 8.2.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

hostname

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

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

password

строка

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

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

Пример: export OME_PASSWORD=пароль

port

целое число

Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular.

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

timeout

целое число

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

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

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

username

строка

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

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

Пример: export OME_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

Примечания

Примечание

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

Примеры

---
- name: Retrieve information about all the OME alert policy categories
  dellemc.openmanage.ome_alert_policies_category_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

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

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

Ключ

Описание

categories

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

Информация о категориях оповещений.

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

Пример: [{"CategoriesDetails": [{"CatalogName": "Application", "Id": 5, "Name": "Configuration", "SubCategoryDetails": [{"Description": "Application", "Id": 85, "Name": "Application"}, {"Description": "Users", "Id": 35, "Name": "Users"}]}, {"CatalogName": "Application", "Id": 7, "Name": "Miscellaneous", "SubCategoryDetails": [{"Description": "Miscellaneous", "Id": 20, "Name": "Miscellaneous"}]}, {"CatalogName": "Application", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Devices", "Id": 90, "Name": "Devices"}]}, {"CatalogName": "Application", "Id": 3, "Name": "Updates", "SubCategoryDetails": [{"Description": "Application", "Id": 85, "Name": "Application"}, {"Description": "Firmware", "Id": 112, "Name": "Firmware"}]}], "IsBuiltIn": true, "Name": "Application"}, {"CategoriesDetails": [{"CatalogName": "Dell Storage", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Other", "Id": 7700, "Name": "Other"}]}, {"CatalogName": "Dell Storage", "Id": 1, "Name": "System Health", "SubCategoryDetails": [{"Description": "Other", "Id": 7700, "Name": "Other"}, {"Description": "Storage", "Id": 18, "Name": "Storage"}]}], "IsBuiltIn": true, "Name": "Dell Storage"}, {"CategoriesDetails": [{"CatalogName": "iDRAC", "Id": 4, "Name": "Audit", "SubCategoryDetails": [{"Description": "Auto System Reset", "Id": 41, "Name": "Auto System Reset"}, {"Description": "UEFI Event", "Id": 55, "Name": "UEFI Event"}, {"Description": "User Tracking", "Id": 56, "Name": "User Tracking"}]}, {"CatalogName": "iDRAC", "Id": 5, "Name": "Configuration", "SubCategoryDetails": [{"Description": "Auto-Discovery", "Id": 49, "Name": "Auto-Discovery"}, {"Description": "vFlash Event", "Id": 66, "Name": "vFlash Event"}, {"Description": "Virtual Console", "Id": 7, "Name": "Virtual Console"}]}, {"CatalogName": "iDRAC", "Id": 2, "Name": "Storage", "SubCategoryDetails": [{"Description": "Battery Event", "Id": 108, "Name": "Battery Event"}, {"Description": "Virtual Disk", "Id": 46, "Name": "Virtual Disk"}]}, {"CatalogName": "iDRAC", "Id": 1, "Name": "System Health", "SubCategoryDetails": [{"Description": "Amperage", "Id": 67, "Name": "Amperage"}, {"Description": "Auto System Reset", "Id": 41, "Name": "Auto System Reset"}, {"Description": "Voltage", "Id": 40, "Name": "Voltage"}]}, {"CatalogName": "iDRAC", "Id": 6, "Name": "Work Notes", "SubCategoryDetails": [{"Description": "BIOS Management", "Id": 54, "Name": "BIOS Management"}]}], "IsBuiltIn": true, "Name": "iDRAC"}]

error_info

словарь

Подробная информация об ошибке HTTP.

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because the resource URI does not exist or is not implemented.", "MessageArgs": [], "MessageId": "CGEN1234", "RelatedProperties": [], "Resolution": "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

строка

Статус операции получения категорий политик оповещений.

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

Пример: "Successfully retrieved alert policies category information."

Авторы

  • 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_alert_policies_category_info_module.html

Spec-Zone.ru

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