cisco.dnac.users_external_servers_v1_info 模块 – 用于用户外部服务器 V1 的信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,有关详细信息,请参阅要求

要在 playbook 中使用它,请指定:cisco.dnac.users_external_servers_v1_info

cisco.dnac 3.1.0 中的新功能

概要

  • 获取所有用户外部服务器 V1。

  • 获取外部用户身份验证服务器。

注意

此模块具有对应的操作插件

要求

在执行此模块的主机上需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

boolean

用于启用调试的 Cisco DNA Center SDK 标志。

选择

  • false ←(默认)

  • true

dnac_host

string / 必需

Cisco DNA Center 主机名。

dnac_password

string

用于身份验证的 Cisco DNA Center 密码。

dnac_port

integer

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

string

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

boolean

启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ←(默认)

dnac_version

string

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值: "2.3.7.6"

headers

dictionary

其他标头。

invokeSource

string

InvokeSource 查询参数。调用此 API 的源。此查询参数的值必须设置为“external”。

validate_response_schema

boolean

用于启用 Cisco DNA Center SDK 根据 JSON 模式验证请求正文的标志。

选择

  • false

  • true ←(默认)

注释

注意

  • 使用的 SDK 方法是 user_and_roles.UserandRoles.get_external_authentication_servers_api_v1,

  • 使用的路径是 get /dna/system/api/v1/users/external-servers,

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档,了解用户和角色 GetExternalAuthenticationServersAPIV1

GetExternalAuthenticationServersAPIV1 API 的完整参考。

示例

- name: Get all Users External Servers V1
  cisco.dnac.users_external_servers_v1_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    invokeSource: string
  register: result

返回值

常见的返回值记录在此处,以下是此模块特有的字段

描述

dnac_response

dictionary

一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应

已返回:始终

示例: {"aaa-servers": [{"aaaAttribute": "string", "accountingPort": 0, "authenticationPort": 0, "protocol": "string", "retries": 0, "role": "string", "serverId": "string", "serverIp": "string", "sharedSecret": "string", "socketTimeout": 0}]}

作者

  • Rafael Campos (@racampos)