Модуль cisco.dnac.roles – Модуль ресурсов для ролей

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

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

Для использования в плейбуке укажите: cisco.dnac.roles.

Новая в cisco.dnac 3.1.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Управление операциями создания, обновления и удаления ресурсов Роли.
Добавление новой роли в системе Cisco DNA Center.
Удаление роли в системе Cisco DNA Center.
Обновление роли в системе Cisco DNA Center.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
description строка	Описание роли.
dnac_debug логическое значение	Флаг для Cisco DNA Center SDK для включения отладки. Выбором: `false` ← (по умолчанию) `true`
dnac_host строка / обязательный	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое значение	Флаг для включения или отключения проверки сертификатов SSL. Выбором: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
resourceTypes список / элементы=словарь	resourceTypes роли.
operations список / элементы=строка	Список операций, разрешенных для приложения. Возможные значения: «gRead», «gWrite», «gUpdate», «gDelete» или их комбинация.
type строка	Название приложения в системе Cisco DNA Center.
role строка	Название роли.
roleId строка	Идентификатор роли.
validate_response_schema логическое значение	Флаг для Cisco DNA Center SDK для включения проверки запрошенных тел против JSON-схемы. Выбором: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: user_and_roles.UserandRoles.add_role_api, user_and_roles.UserandRoles.delete_role_api, user_and_roles.UserandRoles.update_role_api,
Используемые пути: post /dna/system/api/v1/role, delete /dna/system/api/v1/role/{roleId}, put /dna/system/api/v1/role,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по добавлению роли API: Полное описание API AddRoleAPI.
Документация Cisco DNA Center по удалению роли API: Полное описание API DeleteRoleAPI.
Документация Cisco DNA Center по обновлению роли API: Полное описание API UpdateRoleAPI.

Примеры

- name: Create
  cisco.dnac.roles:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    description: string
    resourceTypes:
    - operations:
      - string
      type: string
    role: string

- name: Update all
  cisco.dnac.roles:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    description: string
    resourceTypes:
    - operations:
      - string
      type: string
    roleId: string

- name: Delete by id
  cisco.dnac.roles:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: absent
    roleId: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"message": "string", "roleId": "string"}`

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/dnac/roles_module.html