cisco.dnac.authentication_policy_servers_v1 模块 – 身份验证策略服务器 V1 的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参见要求。

要在 playbook 中使用它，请指定：cisco.dnac.authentication_policy_servers_v1。

cisco.dnac 3.1.0 中的新功能

概要 

管理身份验证策略服务器 V1 资源的创建、更新和删除操作。
用于添加 AAA/ISE 服务器访问配置的 API。协议可以配置为 RADIUS 或 TACACS 或 RADIUS_TACACS。如果配置 Cisco ISE 服务器，配置后，请使用“Cisco ISE 服务器集成状态”Intent API 检查集成状态。根据集成状态，如果需要，请使用“接受 Cisco ISE 服务器集成的 Cisco ISE 服务器证书”Intent API 接受用于 Cisco ISE 服务器集成的 Cisco ISE 证书，然后再次使用“Cisco ISE 服务器集成状态”Intent API 检查集成状态。
用于删除 AAA/ISE 服务器访问配置的 API。
用于编辑 AAA/ISE 服务器访问配置的 API。编辑后，使用“Cisco ISE 服务器集成状态”Intent API 检查集成状态。

注意

此模块具有相应的 action 插件。

要求 

执行此模块的主机需要满足以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
accountingPort 整数	RADIUS 服务器的计费端口（只读）。范围是 1 到 65535。例如 1813。
authenticationPort 整数	RADIUS 服务器的身份验证端口（只读）。范围是 1 到 65535。例如 1812。
ciscoIseDtos 列表 / 元素=字典	身份验证策略服务器的 ciscoIseDtos。
description 字符串	有关 Cisco ISE 服务器的描述。
fqdn 字符串	Cisco ISE 服务器的完全限定域名（只读）。例如 Xi-62.my.com。
ipAddress 字符串	Cisco ISE 服务器的 IP 地址（只读）。
password 字符串	Cisco ISE 服务器的密码。
sshkey 字符串	Cisco ISE 服务器的 SSH 密钥。
subscriberName 字符串	Cisco ISE 服务器的订阅者名称（只读）。例如 Pxgrid_client_1662589467。
userName 字符串	Cisco ISE 服务器的用户名。
dnac_debug 布尔值	Cisco DNA Center SDK 启用调试的标志。选择 `false` ←（默认） `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值： `443`
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值： `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选择 `false` `true` ←（默认）
dnac_version 字符串	通知 SDK 要使用的 Cisco DNA Center 版本。默认值： `"2.3.7.6"`
encryptionKey 字符串	用于加密共享密钥的加密密钥（只读）。
encryptionScheme 字符串	用于提高安全性的加密方案类型（只读）。
externalCiscoIseIpAddrDtos 列表 / 元素=字典	身份验证策略服务器的 externalCiscoIseIpAddrDtos。
externalCiscoIseIpAddresses 列表 / 元素=字典	身份验证策略服务器的 externalCiscoIseIpAddresses。
externalIpAddress 字符串	外部 IP 地址。
type 字符串	类型。
id 字符串	Id 路径参数。身份验证和策略服务器标识符。使用 “获取身份验证和策略服务器” Intent API 来查找标识符。
ipAddress 字符串	身份验证和策略服务器的 IP 地址（只读）。
isIseEnabled 布尔值	对于 Cisco ISE 服务器，值为 true（只读）。默认值为 false。选择 `false` `true`
messageKey 字符串	用于加密共享密钥的消息密钥（只读）。
port 整数	TACACS 服务器的端口（只读）。范围从 1 到 65535。
protocol 字符串	身份验证和策略服务器的协议类型。如果已保存为 RADIUS，可以更新为 RADIUS_TACACS。如果已保存为 TACACS，可以更新为 RADIUS_TACACS。
pxgridEnabled 布尔值	启用时值为 true，禁用时值为 false。默认值为 true。选择 `false` `true`
retries 字符串	设备与身份验证和策略服务器之间的通信重试次数。范围从 1 到 3。
role 字符串	身份验证和策略服务器的角色（只读）。例如，Primary，secondary。
sharedSecret 字符串	设备与身份验证和策略服务器之间的共享密钥（只读）。
timeoutSeconds 字符串	设备与身份验证和策略服务器之间超时前的秒数。范围从 2 到 20。
useDnacCertForPxgrid 布尔值	值为 true 时，使用 DNAC 证书进行 Pxgrid。默认值为 false。选择 `false` `true`
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。选择 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 system_settings.SystemSettings.add_authentication_and_policy_server_access_configuration_v1, system_settings.SystemSettings.delete_authentication_and_policy_server_access_configuration_v1, system_settings.SystemSettings.edit_authentication_and_policy_server_access_configuration_v1,
使用的路径是 post /dna/intent/api/v1/authentication-policy-servers, delete /dna/intent/api/v1/authentication-policy-servers/{id}, put /dna/intent/api/v1/authentication-policy-servers/{id},
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，关于 System Settings AddAuthenticationAndPolicyServerAccessConfigurationV1: AddAuthenticationAndPolicyServerAccessConfigurationV1 API 的完整参考。
Cisco DNA Center 文档，关于 System Settings DeleteAuthenticationAndPolicyServerAccessConfigurationV1: DeleteAuthenticationAndPolicyServerAccessConfigurationV1 API 的完整参考。
Cisco DNA Center 文档，关于 System Settings EditAuthenticationAndPolicyServerAccessConfigurationV1: EditAuthenticationAndPolicyServerAccessConfigurationV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.authentication_policy_servers_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    accountingPort: 0
    authenticationPort: 0
    ciscoIseDtos:
    - description: string
      fqdn: string
      ipAddress: string
      password: string
      sshkey: string
      subscriberName: string
      userName: string
    encryptionKey: string
    encryptionScheme: string
    externalCiscoIseIpAddrDtos:
    - externalCiscoIseIpAddresses:
      - externalIpAddress: string
      type: string
    ipAddress: string
    isIseEnabled: true
    messageKey: string
    port: 0
    protocol: string
    pxgridEnabled: true
    retries: string
    role: string
    sharedSecret: string
    timeoutSeconds: string
    useDnacCertForPxgrid: true

- name: Delete by id
  cisco.dnac.authentication_policy_servers_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: absent
    id: string

- name: Update by id
  cisco.dnac.authentication_policy_servers_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    accountingPort: 0
    authenticationPort: 0
    ciscoIseDtos:
    - description: string
      fqdn: string
      ipAddress: string
      password: string
      sshkey: string
      subscriberName: string
      userName: string
    encryptionKey: string
    encryptionScheme: string
    externalCiscoIseIpAddrDtos:
    - externalCiscoIseIpAddresses:
      - externalIpAddress: string
      type: string
    id: string
    ipAddress: string
    isIseEnabled: true
    messageKey: string
    port: 0
    protocol: string
    pxgridEnabled: true
    retries: string
    role: string
    sharedSecret: string
    timeoutSeconds: string
    useDnacCertForPxgrid: true

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
dnac_response 字典	一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应返回：始终示例： `{"taskId": "string", "url": "string"}`

作者

Rafael Campos (@racampos)