Spec-Zone.ru › Ansible

Модуль cisco.ise.guest_type – Модуль ресурсов для типа гостя

Примечание

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

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

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

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

Новая функция в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

accessTime

словарь

Время доступа типа гостя.

allowAccessOnSpecificDaysTimes

булево

Флаг allowAccessOnSpecificDaysTimes.

Варианты:

  • false
  • true

dayTimeLimits

список / элементы=словарь

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

days

список / элементы=строка

Список дней. Должны быть одним из дней недели. Разрешённые значения: - Воскресенье, - Понедельник, - Вторник, - Среда, - Четверг, - Пятница, - Суббота.

endTime

строка

Конец времени в формате ЧЧ мм.

startTime

строка

Начало времени в формате ЧЧ мм.

defaultDuration

целое число

Значение defaultDuration типа гостя.

durationTimeUnit

строка

Разрешённые значения: - ДНИ, - ЧАСЫ, - МИНУТЫ.

fromFirstLogin

булево

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

Варианты:

  • false
  • true

maxAccountDuration

целое число

Максимальное значение длительности учетной записи.

description

строка

Описание типа гостя.

expirationNotification

словарь

Настройки уведомлений о истечении срока действия.

advanceNotificationDuration

целое число

Отправить уведомление о истечении срока действия за (дни, часы, минуты).

advanceNotificationUnits

строка

Разрешённые значения: - ДНИ, - ЧАСЫ, - МИНУТЫ.

emailText

строка

Текст электронной почты типа гостя.

enableNotification

булево

Включить настройки уведомлений.

Варианты:

  • false
  • true

sendEmailNotification

булево

Включить уведомления по электронной почте.

Варианты:

  • false
  • true

sendSMSNotification

булево

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

Варианты:

  • false
  • true

smsText

строка

Текст SMS типа гостя.

id

строка

Идентификатор типа гостя.

isDefaultType

булево

Флаг isDefaultType.

Варианты:

  • false
  • true

ise_debug

булево

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

Варианты:

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

ise_hostname

строка / обязательно

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

ise_password

строка / обязательно

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

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Время ожидания (в секундах) для RESTful HTTP-запросов.

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

ise_username

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

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

ise_uses_api_gateway

boolean

added in 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

added in cisco.ise 3.0.0

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

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

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

Варианты:

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

ise_verify

boolean

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

Варианты:

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

ise_version

string

Информирует SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

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

Варианты:

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

loginOptions

dictionary

loginOptions для типа гостя.

allowGuestPortalBypass

boolean

Флаг allowGuestPortalBypass.

Варианты:

  • false
  • true

failureAction

string

При превышении лимита гостем, будет вызвано это действие. Допустимые значения - Disconnect_Oldest_Connection, - Disconnect_Newest_Connection.

identityGroupId

string

identityGroupId типа гостя.

limitSimultaneousLogins

boolean

Включить одновременные входы.

Варианты:

  • false
  • true

maxRegisteredDevices

integer

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

maxSimultaneousLogins

integer

Количество одновременных входов.

name

string

Имя типа гостя.

sponsorGroups

list / elements=string

sponsorGroups типа гостя.

Примечания

Примечание

  • Используемые методы SDK: guest_type.GuestType.create_guest_type, guest_type.GuestType.delete_guest_type_by_id, guest_type.GuestType.update_guest_type_by_id,
  • Используемые пути: post /ers/config/guesttype, delete /ers/config/guesttype/{id}, put /ers/config/guesttype/{id},
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    id: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

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

- name: Create
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"accessTime": {"allowAccessOnSpecificDaysTimes": true, "dayTimeLimits": [{"days": ["string"], "endTime": "string", "startTime": "string"}], "defaultDuration": 0, "durationTimeUnit": "string", "fromFirstLogin": true, "maxAccountDuration": 0}, "description": "string", "expirationNotification": {"advanceNotificationDuration": 0, "advanceNotificationUnits": "string", "emailText": "string", "enableNotification": true, "sendEmailNotification": true, "sendSmsNotification": true, "smsText": "string"}, "id": "string", "isDefaultType": true, "link": {"href": "string", "rel": "string", "type": "string"}, "loginOptions": {"allowGuestPortalBypass": true, "failureAction": "string", "identityGroupId": "string", "limitSimultaneousLogins": true, "maxRegisteredDevices": 0, "maxSimultaneousLogins": 0}, "name": "string", "sponsorGroups": ["string"]}

ise_update_response

словарь

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

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

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

Пример: {"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/guest_type_module.html

Spec-Zone.ru

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