Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_device_group – Добавление или удаление устройства (устройств) из статической группы устройств в OpenManage Enterprise

Примечание

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

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

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

Для использования в playbook, укажите: dellemc.openmanage.ome_device_group.

Новое в dellemc.openmanage 3.3.0

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

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

  • Этот модуль позволяет добавлять или удалять устройство (устройства) из статической группы устройств в OpenManage Enterprise.

Требования

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

  • python >= 3.9.6
  • netaddr >= 0.7.19

Параметры

Параметр

Комментарии

ca_path

путь

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

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

device_ids

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

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

device_ids взаимоисключающий с device_service_tags и ip_addresses.

device_service_tags

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

Список служебного тега (тегов) устройства (устройств), которое (которые) необходимо добавить или удалить из группы устройств.

device_service_tags взаимоисключающий с device_ids и ip_addresses.

group_id

целое число

Идентификатор статического устройства.

group_id взаимоисключающий с name.

hostname

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

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

ip_addresses

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

Список IP-адресов устройства (устройств), которое (которые) необходимо добавить или удалить из группы устройств.

ip_addresses взаимоисключающий с device_ids и device_service_tags.

Поддерживаемые форматы диапазонов IP-адресов:

  • 192.35.0.1
  • 10.36.0.0-192.36.0.255
  • 192.37.0.0/24
  • fe80::ffff:ffff:ffff:ffff
  • fe80::ffff:192.0.2.0/125
  • fe80::ffff:ffff:ffff:1111-fe80::ffff:ffff:ffff:ffff

NOTE Имя хоста не поддерживается.

NOTE ip_addresses требует наличия пакета netaddr python для работы с IP-адресами.

NOTE Этот модуль сообщает об успехе, даже если один из IP-адресов, указанных в списке ip_addresses, доступен в OpenManage Enterprise. Модуль сообщает об ошибке, только если ни один из IP-адресов, указанных в списке, недоступен в OpenManage Enterprise.

name

строка

Имя статической группы.

name взаимоисключающий с group_id.

password

строка

Пароль OpenManage Enterprise.

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

Пример: export OME_PASSWORD=password

port

целое число

Порт HTTPS OpenManage Enterprise.

Значение по умолчанию: 443

state

строка

present позволяет добавить устройство (устройства) в статическую группу устройств.

absent позволяет удалить устройство (устройства) из статической группы устройств.

Варианты:

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

timeout

целое число

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

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

Значение по умолчанию: 30

username

строка

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

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

Примечания

Примечание

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

Примеры

---
- name: Add devices to a static device group by using the group name and device IDs
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Storage Services"
    device_ids:
      - 11111
      - 11112
      - 11113

- name: Add devices to a static device group by using the group name and device service tags
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Storage Services"
    device_service_tags:
      - GHRT2RL
      - KJHDF3S
      - LKIJNG6

- name: Add devices to a static device group by using the group ID and device service tags
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    group_id: 12345
    device_service_tags:
      - GHRT2RL
      - KJHDF3S

- name: Add devices to a static device group by using the group name and IPv4 addresses
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Storage Services"
    ip_addresses:
      - 192.35.0.1
      - 192.35.0.5

- name: Add devices to a static device group by using the group ID and IPv6 addresses
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    group_id: 12345
    ip_addresses:
      - fe80::ffff:ffff:ffff:ffff
      - fe80::ffff:ffff:ffff:2222

- name: Add devices to a static device group by using the group ID and supported IPv4 and IPv6 address formats.
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    group_id: 12345
    ip_addresses:
      - 192.35.0.1
      - 10.36.0.0-192.36.0.255
      - 192.37.0.0/24
      - fe80::ffff:ffff:ffff:ffff
      - ::ffff:192.0.2.0/125
      - fe80::ffff:ffff:ffff:1111-fe80::ffff:ffff:ffff:ffff

- name: Remove devices from a static device group by using the group name and device IDs
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "Storage Services"
    device_ids:
      - 11111
      - 11112
      - 11113

- name: Remove devices from a static device group by using the group name and device service tags
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "Storage Services"
    device_service_tags:
      - GHRT2RL
      - KJHDF3S
      - LKIJNG6

- name: Remove devices from a static device group by using the group ID and device service tags
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    group_id: 12345
    device_service_tags:
      - GHRT2RL
      - KJHDF3S

- name: Remove devices from a static device group by using the group name and IPv4 addresses
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "Storage Services"
    ip_addresses:
      - 192.35.0.1
      - 192.35.0.5

- name: Remove devices from a static device group by using the group ID and IPv6 addresses
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    group_id: 12345
    ip_addresses:
      - fe80::ffff:ffff:ffff:ffff
      - fe80::ffff:ffff:ffff:2222

- name: Remove devices from a static device group by using the group ID and supported IPv4 and IPv6 address formats.
  dellemc.openmanage.ome_device_group:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    group_id: 12345
    ip_addresses:
      - 192.35.0.1
      - 10.36.0.0-192.36.0.255
      - 192.37.0.0/24
      - fe80::ffff:ffff:ffff:ffff
      - ::ffff:192.0.2.0/125
      - fe80::ffff:ffff:ffff:1111-fe80::ffff:ffff:ffff:ffff

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

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

Ключ

Описание

error_info

словарь

Подробности HTTP-ошибки.

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

group_id

целое число

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

Возвращается: при успешном выполнении

Пример: 21078

ip_addresses_added

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

IP-адреса, добавленные в группу устройств.

Возвращается: при успешном выполнении

Пример: ["21078"]

msg

строка

Общий статус настроек группы устройств.

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

Пример: "['Successfully added member(s) to the device group.']"

Авторы

  • Felix Stephen (@felixs88)
  • Sajna Shetty (@Sajna-Shetty)
  • Abhishek Sinha (@Abhishek-Dell)

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

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

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

Spec-Zone.ru

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