cisco.ise.admin_user_info 模块 – 管理员用户信息模块

注意

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

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

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

要在playbook中使用它，请指定： cisco.ise.admin_user_info。

cisco.ise 1.0.0 新增

概要 

获取所有管理员用户。
按ID获取管理员用户。
此API允许客户端获取所有管理员用户。
此API允许客户端按ID获取管理员用户。

注意

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

需求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
filter 列表 / 元素=字符串	过滤器查询参数。简单过滤应该可以通过过滤器查询字符串参数实现。过滤器的结构是由字段、运算符和值组成的三元组，用点号分隔。可以发送多个过滤器。所有过滤器条件的逻辑运算符默认为AND，可以使用“filterType=or”查询字符串参数进行更改。每个资源数据模型描述都应指定属性是否是已过滤字段。 “EQ”运算符表示“等于”。 “NEQ”运算符表示“不等于”。 “GT”运算符表示“大于”。 “LT”运算符表示“小于”。 “STARTSW”运算符表示“以…开头”。 “NSTARTSW”运算符表示“不以…开头”。 “ENDSW”运算符表示“以…结尾”。 “NENDSW”运算符表示“不以…结尾”。 “CONTAINS”运算符表示“包含”。 “NCONTAINS”运算符表示“不包含”。
filterType 字符串	FilterType查询参数。所有过滤器条件的逻辑运算符默认为AND，可以使用此参数进行更改。
id 字符串	Id路径参数。
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 Gateway发送请求的标志。如果为true，则使用ISE的API Gateway并将请求发送到 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` ← (默认)
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数。
sortasc 字符串	Sortasc查询参数。升序排序。
sortdsc 字符串	Sortdsc查询参数。降序排序。

注释 

注意

使用的SDK方法是admin_user.AdminUser.get_admin_user_by_id、admin_user.AdminUser.get_admin_users_generator，
使用的路径是get /ers/config/adminuser、get /ers/config/adminuser/{id}，
支持 check_mode
插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco ISE SDK中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

示例 

- name: Get all Admin User
  cisco.ise.admin_user_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get Admin User by id
  cisco.ise.admin_user_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

返回值 

常见的返回值已在此处文档中说明，以下是此模块特有的字段。

键

描述

ise_response

字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表。

返回值：始终返回

示例： {"adminGroups": "string", "changePassword": true, "customAttributes": {}, "description": "string", "enabled": true, "externalUser": true, "id": "string", "inactiveAccountNeverDisabled": true, "includeSystemAlarmsInEmail": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "password": "string"}

ise_responses

列表 / 元素=字典

在cisco.ise 1.1.0中添加

包含 Cisco ISE Python SDK 返回的响应的字典或列表。

返回值：始终返回

示例： "[\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"description\": \"string\",\n \"enabled\": true,\n \"password\": \"string\",\n \"changePassword\": true,\n \"includeSystemAlarmsInEmail\": true,\n \"externalUser\": true,\n \"inactiveAccountNeverDisabled\": true,\n \"adminGroups\": \"string\",\n \"customAttributes\": {},\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

作者

Rafael Campos (@racampos)