cisco.ise.authorization_profile 模块 – 授权配置文件的资源模块

注意

此模块是 cisco.ise 集合(版本 2.9.6)的一部分。

如果您正在使用 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

参数

参数

注释

accessType

字符串

允许的值 - ACCESS_ACCEPT, - ACCESS_REJECT。

acl

字符串

授权配置文件的 acl。

advancedAttributes

列表 / 元素=字典

授权配置文件的 advancedAttributes。

leftHandSideDictionaryAttribue

字典

授权配置文件的 leftHandSideDictionaryAttribue。

AdvancedAttributeValueType

字符串

授权配置文件的 AdvancedAttributeValueType。

attributeName

字符串

授权配置文件的 attributeName。

dictionaryName

字符串

授权配置文件的 dictionaryName。

value

字符串

授权配置文件的 value。

rightHandSideAttribueValue

字典

属性值可以是 AttributeValue 或 AdvancedDictionaryAttribute 类型。对于 AttributeValue,值是 String,对于 AdvancedDictionaryAttribute,值是 dictionaryName 和 attributeName 属性。

AdvancedAttributeValueType

字符串

授权配置文件的 AdvancedAttributeValueType。

attributeName

字符串

授权配置文件的 attributeName。

dictionaryName

字符串

授权配置文件的 dictionaryName。

value

字符串

授权配置文件的 value。

agentlessPosture

布尔值

AgentlessPosture 标志。

选项

  • false

  • true

airespaceACL

字符串

授权配置文件的 airespaceACL。

airespaceIPv6ACL

字符串

授权配置文件的 airespaceIPv6ACL。

asaVpn

字符串

授权配置文件的 asaVpn。

authzProfileType

字符串

允许的值 - SWITCH, - TRUSTSEC, - TACACS SWITCH 用于标准授权配置文件。

autoSmartPort

字符串

授权配置文件的 autoSmartPort。

avcProfile

字符串

授权配置文件的 avcProfile。

daclName

字符串

授权配置文件的 daclName。

description

字符串

授权配置文件的 description。

easywiredSessionCandidate

布尔值

EasywiredSessionCandidate 标志。

选项

  • false

  • true

id

字符串

资源 UUID 值。

interfaceTemplate

字符串

授权配置文件的 interfaceTemplate。

ipv6ACLFilter

字符串

授权配置文件的 ipv6ACLFilter。

ipv6DaclName

字符串

授权配置文件的 ipv6DaclName。

ise_debug

布尔值

用于启用调试的 Identity Services Engine SDK 标志。

选项

  • 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 是否使用 Identity Services Engine 的 API 网关发送请求。

如果为 true,则它使用 ISE 的 API 网关并将请求发送到 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 令牌发送到 ISE 的 ERS API。

如果为 True,则 SDK 假设您的 ISE CSRF 检查已启用。

如果为 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

布尔值

用于启用自动速率限制处理的 Identity Services Engine SDK 标志。

选项

  • false

  • true ←(默认)

macSecPolicy

字符串

允许的值 - MUST_SECURE, - MUST_NOT_SECURE, - SHOULD_SECURE。

name

字符串

资源名称。

neat

布尔值

Neat 标志。

选项

  • false

  • true

profileName

字符串

授权配置文件的 profileName。

reauth

字典

授权配置文件的 reauth。

connectivity

字符串

允许的值 - DEFAULT, - RADIUS_REQUEST。

timer

整数

有效范围是 1-65535。

serviceTemplate

布尔值

ServiceTemplate 标志。

选项

  • false

  • true

trackMovement

布尔值

TrackMovement 标志。

选项

  • false

  • true

vlan

字典

授权配置文件的 vlan。

nameID

字符串

授权配置文件的 nameID。

tagID

整数

有效范围为 0-31。

voiceDomainPermission

布尔值

VoiceDomainPermission 标志。

选项

  • false

  • true

webAuth

布尔值

WebAuth 标志。

选项

  • false

  • true

webRedirection

字典

授权配置文件的 webRedirection。

acl

字符串

授权配置文件的 acl。

displayCertificatesRenewalMessages

布尔值

当 ‘WebRedirectionType’ 的值为 ‘CentralizedWebAuth’ 时,displayCertificatesRenewalMessages 是强制性的。对于所有其他 ‘WebRedirectionType’ 值,该字段必须被忽略。

选项

  • false

  • true

portalName

字符串

数据库中存在的并且符合 WebRedirectionType 的门户。

staticIPHostNameFQDN

字符串

授权配置文件的 staticIPHostNameFQDN。

WebRedirectionType

字符串

值必须是以下之一: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

字典

一个字典或列表,其中包含 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

字典

在 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)