Модуль dellemc.openmanage.ome_groups – Управление статическими группами устройств в OpenManage Enterprise

Примечание

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

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

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

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

Новое в dellemc.openmanage 3.5.0

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

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

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

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации (CA), который будет использоваться для проверки.
description строка	Описание для группы устройств. Это применимо только тогда, когда state равно `present`.
group_id список / элементы=целое число	Идентификатор группы устройств, который необходимо создать, изменить или удалить. Если state отсутствует, можно указать несколько идентификаторов. Этот параметр взаимоисключающий с name.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise.
name список / элементы=строка	Имя группы устройств, которое необходимо создать, изменить или удалить. Если state отсутствует, можно указать несколько имен. Этот параметр нечувствителен к регистру. Этот параметр взаимоисключающий с group_id.
new_name строка	Новое имя для существующей группы устройств. Это применимо только тогда, когда state равно `present`.
parent_group_id целое число	Идентификатор родительской группы устройств, в которой будет создана или изменена группа устройств. Это применимо только тогда, когда state равно `present`. Этот параметр взаимоисключающий с parent_group_name.
parent_group_name строка	Имя родительской группы устройств, в которой будет создана или изменена группа устройств. Это применимо только тогда, когда state равно `present`. `NOTE` Если группа устройств с таким именем не существует, создается группа устройств с parent_group_name. Этот параметр нечувствителен к регистру. Этот параметр взаимоисключающий с parent_group_id. По умолчанию: `"Static Groups"`
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.
Если группа устройств с именем parent_group_name не существует, создается новая группа устройств с таким же именем.
Убедитесь, что введенная родительская группа не является потомком указанной группы.
Запускайте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Create a new device group
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "group 1"
    description: "Group 1 description"
    parent_group_name: "group parent 1"

- name: Modify a device group using the group ID
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    group_id: 1234
    description: "Group description updated"
    parent_group_name: "group parent 2"

- name: Delete a device group using the device group name
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    name: "group 1"

- name: Delete multiple device groups using the group IDs
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    group_id:
      - 1234
      - 5678

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

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

Ключ	Описание
error_info словарь	Подробная информация об HTTP-ошибке. Возвращается: при HTTP-ошибке Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update group 12345 with the provided parent 54321 because a group/parent relationship already exists.", "MessageArgs": ["12345", "54321"], "MessageId": "CGRP9013", "RelatedProperties": [], "Resolution": "Make sure the entered parent ID does not create a bidirectional relationship and retry the operation.", "Severity": "Warning"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}
group_ids список / элементы=целое число	Список идентификаторов удалённых групп устройств. Возвращается: когда state равно `absent` Пример: `[1234, 5678]`
group_status словарь	Подробная информация о статусе операции с группой устройств. Возвращается: при успехе Пример: `{"CreatedBy": "admin", "CreationTime": "2021-01-01 10:10:10.100", "DefinitionDescription": "UserDefined", "DefinitionId": 400, "Description": "my group description", "GlobalStatus": 5000, "HasAttributes": false, "Id": 12123, "IdOwner": 30, "MembershipTypeId": 12, "Name": "group 1", "ParentId": 12345, "TypeId": 3000, "UpdatedBy": "", "UpdatedTime": "2021-01-01 11:11:10.100", "Visible": true}`
invalid_groups список / элементы=строка	Список недопустимых идентификаторов или имён групп устройств. Возвращается: когда state равно `absent` Пример: `["1234", "5678"]`
msg строка	Общий статус операции с группой устройств. Возвращается: всегда Пример: `"Successfully deleted the device group(s)."`

Авторы

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_groups_module.html