Модуль cisco.ise.authorization_profile – Модуль ресурсов для профиля авторизации

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
Тип доступа строка	Допустимые значения - ACCESS_ACCEPT, - ACCESS_REJECT.
acl строка	acl профиля авторизации.
Дополнительные атрибуты список / элементы=словарь	Дополнительные атрибуты профиля авторизации.
Атрибут словаря левой части словарь	Атрибут словаря левой части профиля авторизации.
Тип значения атрибута строка	Тип значения атрибута профиля авторизации.
Имя атрибута строка	Имя атрибута профиля авторизации.
Имя словаря строка	Имя словаря профиля авторизации.
Значение строка	Значение профиля авторизации.
Значение атрибута правой части словарь	Значение атрибута может быть типа AttributeValue или AdvancedDictionaryAttribute. Для AttributeValue значение является строкой, для AdvancedDictionaryAttribute значением являются свойства dictionaryName и attributeName.
Тип значения атрибута строка	Тип значения атрибута профиля авторизации.
Имя атрибута строка	Имя атрибута профиля авторизации.
Имя словаря строка	Имя словаря профиля авторизации.
Значение строка	Значение профиля авторизации.
Бессайтовый режим логическое значение	Флаг бессайтового режима. Варианты: `false` `true`
airespaceACL строка	airespaceACL профиля авторизации.
airespaceIPv6ACL строка	airespaceIPv6ACL профиля авторизации.
asaVpn строка	asaVpn профиля авторизации.
Тип профиля авторизации строка	Допустимые значения - SWITCH, - TRUSTSEC, - TACACS SWITCH используется для стандартных профилей авторизации.
автоматический SmartPort строка	автоматический SmartPort профиля авторизации.
avcProfile строка	avcProfile профиля авторизации.
daclName строка	daclName профиля авторизации.
Описание строка	Описание профиля авторизации.
EasywiredSessionCandidate логическое значение	Флаг EasywiredSessionCandidate. Варианты: `false` `true`
id строка	Значение UUID ресурса.
шаблон интерфейса строка	Шаблон интерфейса профиля авторизации.
ipv6ACLFilter строка	ipv6ACLFilter профиля авторизации.

ipv6DaclName строка	Имя ipv6DaclName профиля авторизации.
ise_debug логический	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP запросов. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway логический добавлен в 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 логический добавлен в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли токен CSRF в API ISE ERS. Если True, SDK предполагает, что проверка CSRF в ISE включена. Если True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логический	Флаг для включения или выключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логический	Флаг для SDK Identity Services Engine для автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
macSecPolicy строка	Допустимые значения: MUST_SECURE, MUST_NOT_SECURE, SHOULD_SECURE.
name строка	Имя ресурса.
neat логический	Флаг neat. Варианты: `false` `true`
profileName строка	Имя профиля авторизации.
reauth словарь	reauth профиля авторизации.
connectivity строка	Допустимые значения: DEFAULT, RADIUS_REQUEST.
timer целое число	Допустимый диапазон: 1-65535.
serviceTemplate логический	Флаг serviceTemplate. Варианты: `false` `true`
trackMovement логический	Флаг trackMovement. Варианты: `false` `true`
vlan словарь	vlan профиля авторизации.

END_OF_DOCUMENT_MARKER

nameID string	Идентификатор имени профиля авторизации.
tagID integer	Допустимый диапазон — от 0 до 31.
voiceDomainPermission boolean	Флаг voiceDomainPermission. Варианты: `false` `true`
webAuth boolean	Флаг webAuth. Варианты: `false` `true`
webRedirection dictionary	WebRedirection профиля авторизации.
acl string	acl профиля авторизации.
displayCertificatesRenewalMessages boolean	Поле displayCertificatesRenewalMessages является обязательным, когда значение ‘WebRedirectionType’ равно ‘CentralizedWebAuth’. Для всех других значений ‘WebRedirectionType’ поле должно быть проигнорировано. Варианты: `false` `true`
portalName string	Портал, существующий в базе данных и соответствующий типу WebRedirectionType.
staticIPHostNameFQDN string	staticIPHostNameFQDN профиля авторизации.
WebRedirectionType string	Значение ДОЛЖНО быть одним из следующих: CentralizedWebAuth, HotSpot, NativeSupplicanProvisioning, ClientProvisioning. Тип WebRedirectionType должен соответствовать значению portalName.

Примечания

Примечание

Используемые методы SDK: authorization_profile.AuthorizationProfile.create_authorization_profile, authorization_profile.AuthorizationProfile.delete_authorization_profile_by_id, authorization_profile.AuthorizationProfile.update_authorization_profile_by_id,
Используемые пути: post /ers/config/authorizationprofile, delete /ers/config/authorizationprofile/{id}, put /ers/config/authorizationprofile/{id},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by id
  cisco.ise.authorization_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessType: string
    acl: string
    advancedAttributes:
    - leftHandSideDictionaryAttribue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
      rightHandSideAttribueValue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
    agentlessPosture: true
    airespaceACL: string
    airespaceIPv6ACL: string
    asaVpn: string
    authzProfileType: string
    autoSmartPort: string
    avcProfile: string
    daclName: string
    description: string
    easywiredSessionCandidate: true
    id: string
    interfaceTemplate: string
    ipv6ACLFilter: string
    ipv6DaclName: string
    macSecPolicy: string
    name: string
    neat: true
    profileName: string
    reauth:
      connectivity: string
      timer: 0
    serviceTemplate: true
    trackMovement: true
    vlan:
      nameID: string
      tagID: 0
    voiceDomainPermission: true
    webAuth: true
    webRedirection:
      WebRedirectionType: string
      acl: string
      displayCertificatesRenewalMessages: true
      portalName: string
      staticIPHostNameFQDN: string

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

- name: Create
  cisco.ise.authorization_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessType: string
    acl: string
    advancedAttributes:
    - leftHandSideDictionaryAttribue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
      rightHandSideAttribueValue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
    agentlessPosture: true
    airespaceACL: string
    airespaceIPv6ACL: string
    asaVpn: string
    authzProfileType: string
    autoSmartPort: string
    avcProfile: string
    daclName: string
    description: string
    easywiredSessionCandidate: true
    id: string
    interfaceTemplate: string
    ipv6ACLFilter: string
    ipv6DaclName: string
    macSecPolicy: string
    name: string
    neat: true
    profileName: string
    reauth:
      connectivity: string
      timer: 0
    serviceTemplate: true
    trackMovement: true
    vlan:
      nameID: string
      tagID: 0
    voiceDomainPermission: true
    webAuth: true
    webRedirection:
      WebRedirectionType: string
      acl: string
      displayCertificatesRenewalMessages: true
      portalName: string
      staticIPHostNameFQDN: string

Возвращаемые значения

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

Ключ	Описание
ise_response dictionary	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: {"accessType": "string", "acl": "string", "advancedAttributes": [{"leftHandSideDictionaryAttribue": {"AdvancedAttributeValueType": "string", "attributeName": "string", "dictionaryName": "string", "value": "string"}, "rightHandSideAttribueValue": {"AdvancedAttributeValueType": "string", "attributeName": "string", "dictionaryName": "string", "value": "string"}}], "agentlessPosture": true, "airespaceACL": "string", "airespaceIPv6ACL": "string", "asaVpn": "string", "authzProfileType": "string", "autoSmartPort": "string", "avcProfile": "string", "daclName": "string", "description": "string", "easywiredSessionCandidate": true, "id": "string", "interfaceTemplate": "string", "ipv6ACLFilter": "string", "ipv6DaclName": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "macSecPolicy": "string", "name": "string", "neat": true, "profileName": "string", "reauth": {"connectivity": "string", "timer": 0}, "serviceTemplate": true, "trackMovement": true, "vlan": {"nameID": "string", "tagID": 0}, "voiceDomainPermission": true, "webAuth": true, "webRedirection": {"WebRedirectionType": "string", "acl": "string", "displayCertificatesRenewalMessages": true, "portalName": "string", "staticIPHostNameFQDN": "string"}}
ise_update_response dictionary добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

dictionary

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

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

Пример: {"accessType": "string", "acl": "string", "advancedAttributes": [{"leftHandSideDictionaryAttribue": {"AdvancedAttributeValueType": "string", "attributeName": "string", "dictionaryName": "string", "value": "string"}, "rightHandSideAttribueValue": {"AdvancedAttributeValueType": "string", "attributeName": "string", "dictionaryName": "string", "value": "string"}}], "agentlessPosture": true, "airespaceACL": "string", "airespaceIPv6ACL": "string", "asaVpn": "string", "authzProfileType": "string", "autoSmartPort": "string", "avcProfile": "string", "daclName": "string", "description": "string", "easywiredSessionCandidate": true, "id": "string", "interfaceTemplate": "string", "ipv6ACLFilter": "string", "ipv6DaclName": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "macSecPolicy": "string", "name": "string", "neat": true, "profileName": "string", "reauth": {"connectivity": "string", "timer": 0}, "serviceTemplate": true, "trackMovement": true, "vlan": {"nameID": "string", "tagID": 0}, "voiceDomainPermission": true, "webAuth": true, "webRedirection": {"WebRedirectionType": "string", "acl": "string", "displayCertificatesRenewalMessages": true, "portalName": "string", "staticIPHostNameFQDN": "string"}}

ise_update_response

dictionary

добавлено в 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/authorization_profile_module.html