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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 list / elements=string	Список строк со ссылками на разрешённые узлы, кластеры или папки.
belongsto_filters_merge_mode string	В режиме слияния существующие настройки объединяются с указанным значением `belongsto_filters`. В режиме замены текущие значения заменяются указанным значением `belongsto_filters`. Варианты: `"merge"` `"replace"` ← (по умолчанию)
description string / обязательный	Описание группы.
managed_filters dictionary	Значения тегов для каждой категории.
managed_filters_merge_mode string	В режиме `merge` существующие категории сохраняются или обновляются, а новые добавляются. В режиме `replace` все категории заменяются указанным значением `managed_filters`. Варианты: `"merge"` `"replace"` ← (по умолчанию)
manageiq_connection dictionary	Параметры подключения к ManageIQ.
ca_cert псевдонимы: ca_bundle_path string	Путь к файлу пакета сертификатов CA или каталогу с сертификатами.
password string	Пароль ManageIQ. Если задана переменная окружения `MIQ_PASSWORD`, используется её значение. В противном случае параметр обязателен, если не передан токен.
token string	Токен ManageIQ. Если задана переменная окружения `MIQ_TOKEN`, используется её значение. В противном случае параметр обязателен, если не переданы имя пользователя или пароль.
url string	URL среды ManageIQ. Если задана переменная окружения `MIQ_URL`, используется её значение. В противном случае URL необходимо указать.
username string	Имя пользователя ManageIQ. Если задана переменная окружения `MIQ_USERNAME`, используется её значение. В противном случае параметр обязателен, если не передан токен.
validate_certs псевдонимы: verify_ssl boolean	Проверять ли сертификаты SSL для запросов HTTPS. Варианты: `false` `true` ← (по умолчанию)
role string	Название роли группы. Если указано, `role_id` имеет приоритет над `role`.
role_id integer	Идентификатор роли группы.
state string	`absent` — группа не должна существовать; `present` — группа должна существовать. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Арендатор группы, указанный по имени. Если указано, `tenant_id` имеет приоритет над `tenant`. Имена арендаторов чувствительны к регистру.
tenant_id integer	Арендатор группы, указанный по идентификатору.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `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 complex	Группа. Возвращается: при успехе
belongsto_filters list / elements=string	Список строк со ссылками на разрешённые узлы, кластеры или папки. Возвращается: при успехе
created_on string	Дата создания группы. Возвращается: при успехе Пример: `"2018-08-12T08:37:55+00:00"`
description string	Описание группы. Возвращается: при успехе
group_type string	Тип группы: системная или пользовательская. Возвращается: при успехе
id integer	Идентификатор группы. Возвращается: при успехе
managed_filters dictionary	Значения тегов для каждой категории. Возвращается: при успехе
role string	Название роли группы. Возвращается: при успехе
tenant string	Имя арендатора группы. Возвращается: при успехе
updated_on integer	Дата обновления группы. Возвращается: при успехе Пример: `"2018-08-12T08:37:55+00:00"`

Авторы

Evert Mulder (@evertmulder)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/manageiq_group_module.html