Spec-Zone.ru › Ansible

Модуль cisco.ise.sponsor_group – Модуль ресурсов для группы спонсоров

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Управление операциями создания, обновления и удаления ресурса Группа спонсоров.
  • Этот API создаёт группу спонсоров.
  • Этот API удаляет группу спонсоров по идентификатору.
  • Этот API позволяет клиенту обновить группу спонсоров по идентификатору.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

autoNotification

boolean

Флаг автоуведомления.

Варианты:

  • false
  • true

createPermissions

dictionary

Права создания для группы спонсоров.

canCreateRandomAccounts

boolean

Флаг возможности создания случайных учетных записей.

Варианты:

  • false
  • true

canImportMultipleAccounts

boolean

Флаг возможности импорта нескольких учетных записей.

Варианты:

  • false
  • true

canSetFutureStartDate

boolean

Флаг возможности установки будущей даты начала.

Варианты:

  • false
  • true

canSpecifyUsernamePrefix

boolean

Флаг возможности указания префикса имени пользователя.

Варианты:

  • false
  • true

defaultUsernamePrefix

string

Префикс имени пользователя по умолчанию для группы спонсоров.

importBatchSizeLimit

integer

Предел размера пакета импорта для группы спонсоров.

randomBatchSizeLimit

integer

Предел размера пакета случайных данных для группы спонсоров.

startDateFutureLimitDays

integer

Предел дней в будущем для даты начала для группы спонсоров.

description

string

Описание группы спонсоров.

guestTypes

list / elements=string

Типы гостей для группы спонсоров.

id

string

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

isDefaultGroup

boolean

Флаг по умолчанию.

Варианты:

  • false
  • true

ise_debug

boolean

Флаг отладки Identity Services Engine SDK.

Варианты:

  • false ← (по умолчанию)
  • true

ise_hostname

string / обязательно

Имя хоста Identity Services Engine.

ise_password

string / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

integer

добавлено в cisco.ise 3.0.0

Таймаут (в секундах) для запросов RESTful HTTP.

По умолчанию: 60

ise_username

string / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

boolean

добавлено в cisco.ise 1.1.0

Флаг, указывающий SDK использовать ли API шлюз Identity Services Engine для отправки запросов.

Если значение true, используется API шлюз ISE и отправляются запросы на https://{{ise_hostname}}.

Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

  • false
  • true ← (по умолчанию)

ise_uses_csrf_token

boolean

добавлено в cisco.ise 3.0.0

Флаг, указывающий SDK, отправлять ли токен CSRF в ERS API ISE.

Если значение True, SDK предполагает, что проверка CSRF в вашем ISE включена.

Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

  • false ← (по умолчанию)
  • true

ise_verify

boolean

Флаг для включения или отключения проверки SSL-сертификата.

Варианты:

  • false
  • true ← (default)

ise_version

string

Сообщает SDK, какую версию Identity Services Engine использовать.

Значение по умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

Флаг для SDK Identity Services Engine для включения автоматической обработки ограничения скорости.

Варианты:

  • false
  • true ← (default)

isEnabled

boolean

Флаг IsEnabled.

Варианты:

  • false
  • true

locations

list / elements=string

Расположения группы спонсоров.

managePermission

string

managePermission группы спонсоров.

memberGroups

list / elements=string

memberGroups группы спонсоров.

name

string

Название группы спонсоров.

otherPermissions

dictionary

otherPermissions группы спонсоров.

canAccessViaREST

boolean

Флаг CanAccessViaREST.

Варианты:

  • false
  • true

canApproveSelfregGuests

boolean

Флаг CanApproveSelfregGuests.

Варианты:

  • false
  • true

canDeleteGuestAccounts

boolean

Флаг CanDeleteGuestAccounts.

Варианты:

  • false
  • true

canExtendGuestAccounts

boolean

Флаг CanExtendGuestAccounts.

Варианты:

  • false
  • true

canReinstateSuspendedAccounts

boolean

Флаг CanReinstateSuspendedAccounts.

Варианты:

  • false
  • true

canResetGuestPasswords

boolean

Флаг CanResetGuestPasswords.

Варианты:

  • false
  • true

canSendSMSNotifications

boolean

Флаг CanSendSMSNotifications.

Варианты:

  • false
  • true

canSuspendGuestAccounts

boolean

Флаг CanSuspendGuestAccounts.

Варианты:

  • false
  • true

canUpdateGuestContactInfo

boolean

Флаг CanUpdateGuestContactInfo.

Варианты:

  • false
  • true

canViewGuestPasswords

boolean

Флаг CanViewGuestPasswords.

Варианты:

  • false
  • true

limitApprovalToSponsorsGuests

boolean

Флаг LimitApprovalToSponsorsGuests.

Варианты:

  • false
  • true

requireSuspensionReason

boolean

Флаг requireSuspensionReason.

Варианты:

  • false
  • true

Примечания

Примечание

  • Используемые методы SDK: sponsor_group.SponsorGroup.create_sponsor_group, sponsor_group.SponsorGroup.delete_sponsor_group_by_id, sponsor_group.SponsorGroup.update_sponsor_group_by_id,
  • Используемые пути: post /ers/config/sponsorgroup, delete /ers/config/sponsorgroup/{id}, put /ers/config/sponsorgroup/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.sponsor_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    autoNotification: true
    createPermissions:
      canCreateRandomAccounts: true
      canImportMultipleAccounts: true
      canSetFutureStartDate: true
      canSpecifyUsernamePrefix: true
      defaultUsernamePrefix: string
      importBatchSizeLimit: 0
      randomBatchSizeLimit: 0
      startDateFutureLimitDays: 0
    description: string
    guestTypes:
    - string
    id: string
    isDefaultGroup: true
    isEnabled: true
    locations:
    - string
    managePermission: string
    memberGroups:
    - string
    name: string
    otherPermissions:
      canAccessViaRest: true
      canApproveSelfregGuests: true
      canDeleteGuestAccounts: true
      canExtendGuestAccounts: true
      canReinstateSuspendedAccounts: true
      canResetGuestPasswords: true
      canSendSmsNotifications: true
      canSuspendGuestAccounts: true
      canUpdateGuestContactInfo: true
      canViewGuestPasswords: true
      limitApprovalToSponsorsGuests: true
      requireSuspensionReason: true

- name: Delete by id
  cisco.ise.sponsor_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.sponsor_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    autoNotification: true
    createPermissions:
      canCreateRandomAccounts: true
      canImportMultipleAccounts: true
      canSetFutureStartDate: true
      canSpecifyUsernamePrefix: true
      defaultUsernamePrefix: string
      importBatchSizeLimit: 0
      randomBatchSizeLimit: 0
      startDateFutureLimitDays: 0
    description: string
    guestTypes:
    - string
    isDefaultGroup: true
    isEnabled: true
    locations:
    - string
    managePermission: string
    memberGroups:
    - string
    name: string
    otherPermissions:
      canAccessViaRest: true
      canApproveSelfregGuests: true
      canDeleteGuestAccounts: true
      canExtendGuestAccounts: true
      canReinstateSuspendedAccounts: true
      canResetGuestPasswords: true
      canSendSmsNotifications: true
      canSuspendGuestAccounts: true
      canUpdateGuestContactInfo: true
      canViewGuestPasswords: true
      limitApprovalToSponsorsGuests: true
      requireSuspensionReason: true

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

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

Ключ

Описание

ise_response

словарь

Словарь или список с ответом, возвращенным Cisco ISE Python SDK

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

Пример: {"autoNotification": true, "createPermissions": {"canCreateRandomAccounts": true, "canImportMultipleAccounts": true, "canSetFutureStartDate": true, "canSpecifyUsernamePrefix": true, "defaultUsernamePrefix": "string", "importBatchSizeLimit": 0, "randomBatchSizeLimit": 0, "startDateFutureLimitDays": 0}, "description": "string", "guestTypes": ["string"], "id": "string", "isDefaultGroup": true, "isEnabled": true, "link": {"href": "string", "rel": "string", "type": "string"}, "locations": ["string"], "managePermission": "string", "memberGroups": ["string"], "name": "string", "otherPermissions": {"canAccessViaRest": true, "canApproveSelfregGuests": true, "canDeleteGuestAccounts": true, "canExtendGuestAccounts": true, "canReinstateSuspendedAccounts": true, "canResetGuestPasswords": true, "canSendSmsNotifications": true, "canSuspendGuestAccounts": true, "canUpdateGuestContactInfo": true, "canViewGuestPasswords": true, "limitApprovalToSponsorsGuests": true, "requireSuspensionReason": true}}

ise_update_response

словарь

добавлено в cisco.ise 1.1.0

Словарь или список с ответом, возвращенным Cisco ISE Python SDK

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

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/ise/sponsor_group_module.html

Spec-Zone.ru

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