cisco.ise.allowed_protocols 模块 – 允许协议的资源模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list。
要安装它,请使用: ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在剧本中使用它,请指定: cisco.ise.allowed_protocols。
cisco.ise 1.0.0 中的新增功能
概要
- 管理允许协议资源的创建、更新和删除操作。 
- 此 API 创建允许的协议。 
- 此 API 删除允许的协议。 
- 此 API 允许客户端更新允许的协议。 
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
- ciscoisesdk >= 2.2.3 
- python >= 3.5 
参数
| 参数 | 注释 | 
|---|---|
| AllowChap 标志。 选项 
 | |
| AllowEapFast 标志。 选项 
 | |
| AllowEapMd5 标志。 选项 
 | |
| AllowEapTls 标志。 选项 
 | |
| AllowEapTtls 标志。 选项 
 | |
| AllowLeap 标志。 选项 
 | |
| AllowMsChapV1 标志。 选项 
 | |
| AllowMsChapV2 标志。 选项 
 | |
| AllowPapAscii 标志。 选项 
 | |
| AllowPeap 标志。 选项 
 | |
| AllowPreferredEapProtocol 标志。 选项 
 | |
| AllowTeap 标志。 选项 
 | |
| AllowWeakCiphersForEap 标志。 选项 
 | |
| 允许协议的描述。 | |
| 只有当 allowEapFast 为 true 时才需要 eapFast,否则必须忽略它。对象 eapFast 包含 EAP FAST 协议的设置。 | |
| AllowEapFastEapGtc 标志。 选项 
 | |
| 只有当 allowEapFastEapGtc 为 true 时才需要 allowEapFastEapGtcPwdChange,否则必须忽略它。 选项 
 | |
| 只有当 allowEapFastEapGtc 为 true 时才需要 allowEapFastEapGtcPwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| AllowEapFastEapMsChapV2 标志。 选项 
 | |
| 只有当 allowEapFastEapMsChapV2 为 true 时才需要 allowEapFastEapMsChapV2PwdChange,否则必须忽略它。 选项 
 | |
| 只有当 eapTtlsEapMsChapV2 为 true 时才需要 allowEapFastEapMsChapV2PwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| AllowEapFastEapTls 标志。 选项 
 | |
| 只有当 allowEapFastEapTls 为 true 时才需要 allowEapFastEapTlsAuthOfExpiredCerts,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 FALSE 时才需要 eapFastDontUsePacsAcceptClientCert,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 FALSE 时才需要 eapFastDontUsePacsAllowMachineAuthentication,否则必须忽略它。 选项 
 | |
| EapFastEnableEAPChaining 标志。 选项 
 | |
| EapFastUsePacs 标志。 选项 
 | |
| 只有当 eapFastUsePacsAllowAuthenProvisioning 为 true 时才需要 eapFastUsePacsAcceptClientCert,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsAllowAnonymProvisioning,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsAllowAuthenProvisioning,否则必须忽略它。 选项 
 | |
| EapFastUsePacsAllowMachineAuthentication 标志。 选项 
 | |
| 只有当 eapFastUsePacsStatelessSessionResume 为 true 时才需要 eapFastUsePacsAuthorizationPacTtl,否则必须忽略它。 | |
| 只有当 eapFastUsePacsStatelessSessionResume 为 true 时才需要 eapFastUsePacsAuthorizationPacTtlUnits,否则必须忽略它。允许的值 - SECONDS、- MINUTES、- HOURS、- DAYS、- WEEKS。 | |
| 只有当 eapFastUsePacsAllowMachineAuthentication 为 true 时才需要 eapFastUsePacsMachinePacTtl,否则必须忽略它。 | |
| 只有当 eapFastUsePacsAllowMachineAuthentication 为 true 时才需要 eapFastUsePacsMachinePacTtlUnits,否则必须忽略它。允许的值 - SECONDS、- MINUTES、- HOURS、- DAYS、- WEEKS。 | |
| 只有当 eapFastUsePacsAllowAuthenProvisioning 为 true 时才需要 eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsStatelessSessionResume,否则必须忽略它。 选项 
 | |
| 只有当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsTunnelPacTtl,否则必须忽略它。 | |
| 仅当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsTunnelPacTtlUnits,否则必须忽略它。允许的值 - SECONDS、- MINUTES、- HOURS、- DAYS、- WEEKS。 | |
| 仅当 eapFastUsePacs 为 true 时才需要 eapFastUsePacsUseProactivePacUpdatePrecentage,否则必须忽略它。 | |
| 仅当 allowEapTls 为 true 时才需要 eapTls,否则必须忽略它。对象 eapTls 包含 EAP TLS 协议的设置。 | |
| AllowEapTlsAuthOfExpiredCerts 标志。 选项 
 | |
| EapTlsEnableStatelessSessionResume 标志。 选项 
 | |
| 仅当 eapTlsEnableStatelessSessionResume 为 true 时才需要 eapTlsSessionTicketPrecentage,否则必须忽略它。 | |
| 生存时间。仅当 eapTlsEnableStatelessSessionResume 为 true 时才需要 eapTlsSessionTicketTtl,否则必须忽略它。 | |
| 生存时间单位。仅当 eapTlsEnableStatelessSessionResume 为 true 时才需要 eapTlsSessionTicketTtlUnits,否则必须忽略它。允许的值 - SECONDS、- MINUTES、- HOURS、- DAYS、- WEEKS。 | |
| EapTlsLBit 标志。 选项 
 | |
| 仅当 allowEapTtls 为 true 时才需要 eapTtls,否则必须忽略它。对象 eapTtls 包含 EAP TTLS 协议的设置。 | |
| EapTtlsChap 标志。 选项 
 | |
| EapTtlsEapMd5 标志。 选项 
 | |
| EapTtlsEapMsChapV2 标志。 选项 
 | |
| 仅当 eapTtlsEapMsChapV2 为 true 时才需要 eapTtlsEapMsChapV2PwdChange,否则必须忽略它。 选项 
 | |
| 仅当 eapTtlsEapMsChapV2 为 true 时才需要 eapTtlsEapMsChapV2PwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| EapTtlsMsChapV1 标志。 选项 
 | |
| EapTtlsMsChapV2 标志。 选项 
 | |
| EapTtlsPapAscii 标志。 选项 
 | |
| 资源 UUID,更新时必填。 | |
| 用于 Identity Services Engine SDK 的标志,用于启用调试。 选项 
 | |
| Identity Services Engine 主机名。 | |
| 用于身份验证的 Identity Services Engine 密码。 | |
| RESTful HTTP 请求的超时时间(以秒为单位)。 默认值:  | |
| 用于身份验证的 Identity Services Engine 用户名。 | |
| 通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True,则 SDK 假设您的 ISE CSRF 检查已启用。 如果为 True,则假设您需要 SDK 自动为您管理 CSRF 令牌。 选项 
 | |
| 启用或禁用 SSL 证书验证的标志。 选项 
 | |
| 通知 SDK 使用哪个版本的 Identity Services Engine。 默认值:  | |
| 用于 Identity Services Engine SDK 的标志,用于启用自动速率限制处理。 选项 
 | |
| 资源名称。 | |
| 允许的协议的 peap。 | |
| AllowPeapEapGtc 标志。 选项 
 | |
| 仅当 allowPeapEapGtc 为 true 时才需要 allowPeapEapGtcPwdChange,否则必须忽略它。 选项 
 | |
| 仅当 allowPeapEapGtc 为 true 时才需要 allowPeapEapGtcPwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| AllowPeapEapMsChapV2 标志。 选项 
 | |
| 仅当 allowPeapEapMsChapV2 为 true 时才需要 allowPeapEapMsChapV2PwdChange,否则必须忽略它。 选项 
 | |
| 仅当 allowPeapEapMsChapV2 为 true 时才需要 allowPeapEapMsChapV2PwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| AllowPeapEapTls 标志。 选项 
 | |
| 仅当 allowPeapEapTls 为 true 时才需要 allowPeapEapTlsAuthOfExpiredCerts,否则必须忽略它。 选项 
 | |
| AllowPeapV0 标志。 选项 
 | |
| RequireCryptobinding 标志。 选项 
 | |
| 仅当 allowPreferredEapProtocol 为 true 时才需要 preferredEapProtocol,否则必须忽略它。允许的值 - EAP_FAST、- PEAP、- LEAP、- EAP_MD5、- EAP_TLS、- EAP_TTLS、- TEAP。 | |
| ProcessHostLookup 标志。 选项 
 | |
| RequireMessageAuth 标志。 选项 
 | |
| 仅当 allowTeap 为 true 时才需要 teap,否则必须忽略它。对象 teap 包含 TEAP 协议的设置。 | |
| AcceptClientCertDuringTunnelEst 标志。 选项 
 | |
| AllowDowngradeMsk 标志。 选项 
 | |
| AllowTeapEapMsChapV2 标志。 选项 
 | |
| 仅当 allowTeapEapMsChapV2 为 true 时才需要 allowTeapEapMsChapV2PwdChange,否则必须忽略它。 选项 
 | |
| 仅当 allowTeapEapMsChapV2 为 true 时才需要 allowTeapEapMsChapV2PwdChangeRetries,否则必须忽略它。有效范围是 0-3。 | |
| AllowTeapEapTls 标志。 选项 
 | |
| 仅当 allowTeapEapTls 为 true 时才需要 allowTeapEapTlsAuthOfExpiredCerts,否则必须忽略它。 选项 
 | |
| EnableEapChaining 标志。 选项 
 | 
注释
注意
- 使用的 SDK 方法为 allowed_protocols.AllowedProtocols.create_allowed_protocol、allowed_protocols.AllowedProtocols.delete_allowed_protocol_by_id、allowed_protocols.AllowedProtocols.update_allowed_protocol_by_id, 
- 使用的路径为 post /ers/config/allowedprotocols、delete /ers/config/allowedprotocols/{id}、put /ers/config/allowedprotocols/{id}, 
- 不支持 - check_mode
- 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用来自 Cisco ISE SDK 的嵌入式连接管理器。 
- 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。 
示例
- name: Update by id
  cisco.ise.allowed_protocols:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowChap: true
    allowEapFast: true
    allowEapMd5: true
    allowEapTls: true
    allowEapTtls: true
    allowLeap: true
    allowMsChapV1: true
    allowMsChapV2: true
    allowPapAscii: true
    allowPeap: true
    allowPreferredEapProtocol: true
    allowTeap: true
    allowWeakCiphersForEap: true
    description: string
    eapFast:
      allowEapFastEapGtc: true
      allowEapFastEapGtcPwdChange: true
      allowEapFastEapGtcPwdChangeRetries: 0
      allowEapFastEapMsChapV2: true
      allowEapFastEapMsChapV2PwdChange: true
      allowEapFastEapMsChapV2PwdChangeRetries: 0
      allowEapFastEapTls: true
      allowEapFastEapTlsAuthOfExpiredCerts: true
      eapFastDontUsePacsAcceptClientCert: true
      eapFastDontUsePacsAllowMachineAuthentication: true
      eapFastEnableEAPChaining: true
      eapFastUsePacs: true
      eapFastUsePacsAcceptClientCert: true
      eapFastUsePacsAllowAnonymProvisioning: true
      eapFastUsePacsAllowAuthenProvisioning: true
      eapFastUsePacsAllowMachineAuthentication: true
      eapFastUsePacsAuthorizationPacTtl: 0
      eapFastUsePacsAuthorizationPacTtlUnits: string
      eapFastUsePacsMachinePacTtl: 0
      eapFastUsePacsMachinePacTtlUnits: string
      eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning: true
      eapFastUsePacsStatelessSessionResume: true
      eapFastUsePacsTunnelPacTtl: 0
      eapFastUsePacsTunnelPacTtlUnits: string
      eapFastUsePacsUseProactivePacUpdatePrecentage: 0
    eapTls:
      allowEapTlsAuthOfExpiredCerts: true
      eapTlsEnableStatelessSessionResume: true
      eapTlsSessionTicketPrecentage: 0
      eapTlsSessionTicketTtl: 0
      eapTlsSessionTicketTtlUnits: string
    eapTlsLBit: true
    eapTtls:
      eapTtlsChap: true
      eapTtlsEapMd5: true
      eapTtlsEapMsChapV2: true
      eapTtlsEapMsChapV2PwdChange: true
      eapTtlsEapMsChapV2PwdChangeRetries: 0
      eapTtlsMsChapV1: true
      eapTtlsMsChapV2: true
      eapTtlsPapAscii: true
    id: string
    name: string
    peap:
      allowPeapEapGtc: true
      allowPeapEapGtcPwdChange: true
      allowPeapEapGtcPwdChangeRetries: 0
      allowPeapEapMsChapV2: true
      allowPeapEapMsChapV2PwdChange: true
      allowPeapEapMsChapV2PwdChangeRetries: 0
      allowPeapEapTls: true
      allowPeapEapTlsAuthOfExpiredCerts: true
      allowPeapV0: true
      requireCryptobinding: true
    preferredEapProtocol: string
    processHostLookup: true
    requireMessageAuth: true
    teap:
      acceptClientCertDuringTunnelEst: true
      allowDowngradeMsk: true
      allowTeapEapMsChapV2: true
      allowTeapEapMsChapV2PwdChange: true
      allowTeapEapMsChapV2PwdChangeRetries: 0
      allowTeapEapTls: true
      allowTeapEapTlsAuthOfExpiredCerts: true
      enableEapChaining: true
- name: Delete by id
  cisco.ise.allowed_protocols:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string
- name: Create
  cisco.ise.allowed_protocols:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowChap: true
    allowEapFast: true
    allowEapMd5: true
    allowEapTls: true
    allowEapTtls: true
    allowLeap: true
    allowMsChapV1: true
    allowMsChapV2: true
    allowPapAscii: true
    allowPeap: true
    allowPreferredEapProtocol: true
    allowTeap: true
    allowWeakCiphersForEap: true
    description: string
    eapFast:
      allowEapFastEapGtc: true
      allowEapFastEapGtcPwdChange: true
      allowEapFastEapGtcPwdChangeRetries: 0
      allowEapFastEapMsChapV2: true
      allowEapFastEapMsChapV2PwdChange: true
      allowEapFastEapMsChapV2PwdChangeRetries: 0
      allowEapFastEapTls: true
      allowEapFastEapTlsAuthOfExpiredCerts: true
      eapFastDontUsePacsAcceptClientCert: true
      eapFastDontUsePacsAllowMachineAuthentication: true
      eapFastEnableEAPChaining: true
      eapFastUsePacs: true
      eapFastUsePacsAcceptClientCert: true
      eapFastUsePacsAllowAnonymProvisioning: true
      eapFastUsePacsAllowAuthenProvisioning: true
      eapFastUsePacsAllowMachineAuthentication: true
      eapFastUsePacsAuthorizationPacTtl: 0
      eapFastUsePacsAuthorizationPacTtlUnits: string
      eapFastUsePacsMachinePacTtl: 0
      eapFastUsePacsMachinePacTtlUnits: string
      eapFastUsePacsReturnAccessAcceptAfterAuthenticatedProvisioning: true
      eapFastUsePacsStatelessSessionResume: true
      eapFastUsePacsTunnelPacTtl: 0
      eapFastUsePacsTunnelPacTtlUnits: string
      eapFastUsePacsUseProactivePacUpdatePrecentage: 0
    eapTls:
      allowEapTlsAuthOfExpiredCerts: true
      eapTlsEnableStatelessSessionResume: true
      eapTlsSessionTicketPrecentage: 0
      eapTlsSessionTicketTtl: 0
      eapTlsSessionTicketTtlUnits: string
    eapTlsLBit: true
    eapTtls:
      eapTtlsChap: true
      eapTtlsEapMd5: true
      eapTtlsEapMsChapV2: true
      eapTtlsEapMsChapV2PwdChange: true
      eapTtlsEapMsChapV2PwdChangeRetries: 0
      eapTtlsMsChapV1: true
      eapTtlsMsChapV2: true
      eapTtlsPapAscii: true
    name: string
    peap:
      allowPeapEapGtc: true
      allowPeapEapGtcPwdChange: true
      allowPeapEapGtcPwdChangeRetries: 0
      allowPeapEapMsChapV2: true
      allowPeapEapMsChapV2PwdChange: true
      allowPeapEapMsChapV2PwdChangeRetries: 0
      allowPeapEapTls: true
      allowPeapEapTlsAuthOfExpiredCerts: true
      allowPeapV0: true
      requireCryptobinding: true
    preferredEapProtocol: string
    processHostLookup: true
    requireMessageAuth: true
    teap:
      acceptClientCertDuringTunnelEst: true
      allowDowngradeMsk: true
      allowTeapEapMsChapV2: true
      allowTeapEapMsChapV2PwdChange: true
      allowTeapEapMsChapV2PwdChangeRetries: 0
      allowTeapEapTls: true
      allowTeapEapTlsAuthOfExpiredCerts: true
      enableEapChaining: true
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段。
| 键 | 描述 | 
|---|---|
| 包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回:始终返回 示例:  | |
| 包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回:始终返回 示例:  | 
