Модуль community.general.manageiq_group – Управление группами в ManageIQ

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Чтобы использовать его в книге задач, укажите: community.general.manageiq_group.

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

Описание

Модуль manageiq_group поддерживает добавление, обновление и удаление групп в ManageIQ.

Требования

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

manageiq-client
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/

Параметры

Параметр	Комментарии
belongsto_filters список / элементы=строка	Список строк со ссылкой на разрешенный хост, кластер или папку
belongsto_filters_merge_mode строка	В режиме слияния существующие настройки объединяются с предоставленным `belongsto_filters`. В режиме замещения текущие значения заменяются предоставленным `belongsto_filters`. Варианты: `"merge"` `"replace"` ← (по умолчанию)
description строка / обязательно	Описание группы.
managed_filters словарь	Значения тегов по категориям
managed_filters_merge_mode строка	В режиме слияния существующие категории сохраняются или обновляются, новые категории добавляются. В режиме замещения все категории будут заменены на предоставленные `managed_filters`. Варианты: `"merge"` `"replace"` ← (по умолчанию)
manageiq_connection словарь	Информация о конфигурации подключения ManageIQ.
ca_cert псевдонимы: ca_bundle_path строка	Путь к файлу пакета сертификатов CA или каталогу с сертификатами.
пароль строка	Пароль ManageIQ. `MIQ_PASSWORD` переменная окружения, если она задана. В противном случае, требуется, если не передан токен.
токен строка	Токен ManageIQ. `MIQ_TOKEN` переменная окружения, если она задана. В противном случае, требуется, если не передан ни имя пользователя, ни пароль.
url строка	URL среды ManageIQ. `MIQ_URL` переменная окружения, если она задана. В противном случае, её нужно передать.
имя пользователя строка	Имя пользователя ManageIQ. `MIQ_USERNAME` переменная окружения, если она задана. В противном случае, требуется, если не передан токен.
validate_certs псевдонимы: verify_ssl логическое	Проверять ли SSL-сертификаты для HTTPS-запросов. Варианты: `false` `true` ← (по умолчанию)
роль строка	Имя роли группы `role_id` имеет приоритет над `role` при указании.
id_роли целое число	Идентификатор роли группы
состояние строка	absent - группа не должна существовать, present - группа должна существовать. Варианты: `"absent"` `"present"` ← (по умолчанию)
арендатор строка	Арендатор для группы, определенный по имени арендатора. `tenant_id` имеет приоритет над `tenant` при указании. Имена арендаторов чувствительны к регистру.
id_арендатора целое число	Арендатор для группы, определенный по идентификатору арендатора.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения без модификации целевого объекта.
diff_mode	Поддержка: нет	Вернёт подробности о том, что изменилось (или, возможно, что нужно изменить в `check_mode`) при работе в режиме сравнения.

Примеры

- name: Create a group in ManageIQ with the role EvmRole-user and tenant 'my_tenant'
  community.general.manageiq_group:
    description: 'MyGroup-user'
    role: 'EvmRole-user'
    tenant: 'my_tenant'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

- name: Create a group in ManageIQ with the role EvmRole-user and tenant with tenant_id 4
  community.general.manageiq_group:
    description: 'MyGroup-user'
    role: 'EvmRole-user'
    tenant_id: 4
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

- name:
  - Create or update a group in ManageIQ with the role EvmRole-user and tenant my_tenant.
  - Apply 3 prov_max_cpu and 2 department tags to the group.
  - Limit access to a cluster for the group.
  community.general.manageiq_group:
    description: 'MyGroup-user'
    role: 'EvmRole-user'
    tenant: my_tenant
    managed_filters:
      prov_max_cpu:
      - '1'
      - '2'
      - '4'
      department:
      - defense
      - engineering
    managed_filters_merge_mode: replace
    belongsto_filters:
    - "/belongsto/ExtManagementSystem|ProviderName/EmsFolder|Datacenters/EmsFolder|dc_name/EmsFolder|host/EmsCluster|Cluster name"
    belongsto_filters_merge_mode: merge
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

- name: Delete a group in ManageIQ
  community.general.manageiq_group:
    state: 'absent'
    description: 'MyGroup-user'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'

- name: Delete a group in ManageIQ using a token
  community.general.manageiq_group:
    state: 'absent'
    description: 'MyGroup-user'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'

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

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

Ключ	Описание
group сложный	Группа. Возвращается: успешно
belongsto_filters список / элементы=строка	Список строк со ссылкой на разрешённый хост, кластер или папку Возвращается: успешно
created_on строка	Дата создания группы Возвращается: успешно Пример: `"2018-08-12T08:37:55+00:00"`
description строка	Описание группы Возвращается: успешно
group_type строка	Тип группы: системная или пользовательская Возвращается: успешно
id целое число	Идентификатор группы Возвращается: успешно
managed_filters словарь	Значения тегов по категориям Возвращается: успешно
role строка	Имя роли группы Возвращается: успешно
tenant строка	Имя группы арендатора Возвращается: успешно
updated_on целое число	Дата обновления группы Возвращается: успешно Пример: `"2018-08-12T08:37:55+00:00"`

Авторы

Evert Mulder (@evertmulder)

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

© 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/community/general/manageiq_group_module.html