cisco.ise.internal_user 模块 – 内部用户资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅 要求了解详情。

要在剧本中使用它，请指定：cisco.ise.internal_user。

cisco.ise 1.0.0 中的新增功能

概要

• 管理内部用户的创建、更新和删除操作。

• 此 API 创建一个内部用户。

• 此 API 通过 ID 删除内部用户。

• 此 API 通过名称删除内部用户。

• 此 API 允许客户端通过 ID 更新内部用户。

• 此 API 允许客户端通过名称更新内部用户。

注意

此模块具有相应的 操作插件。

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
changePassword 布尔值	更改密码标志。 选项 false true
customAttributes 字典	键值映射。
description 字符串	内部用户的描述。
email 字符串	内部用户的电子邮件。
enabled 布尔值	用户是否启用/禁用。用作过滤器时，值应为“Enabled”或“Disabled”。这些值区分大小写。例如，“ERSObjectURL?filter=enabled.EQ.Enabled”。 选项 false true
enablePassword 字符串	内部用户的 enablePassword。
expiryDate 字符串	存储内部用户的过期日期信息。格式为“YYYY-MM-DD”。
expiryDateEnabled 布尔值	ExpiryDateEnabled 标志。 选项 false true
firstName 字符串	内部用户的firstName。
id 字符串	内部用户的ID。
identityGroups 字符串	身份组 ID 的 CSV。
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 网关发送请求的标志。 如果为真，则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。 如果为假，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。 选项 false true ← (默认)
ise_uses_csrf_token 布尔值 在 cisco.ise 3.0.0 中添加	告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为真，则 SDK 假设您的 ISE CSRF 检查已启用。 如果为真，则假设您需要 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 ← (默认)
lastName 字符串	内部用户的 lastName。
name 字符串	内部用户的名称。
password 字符串	内部用户的密码。
passwordIDStore 字符串	保存内部用户密码的 ID 存储。

注释

注意

• 使用的 SDK 方法为 internal_user.InternalUser.create_internal_user、internal_user.InternalUser.delete_internal_user_by_id、internal_user.InternalUser.delete_internal_user_by_name、internal_user.InternalUser.update_internal_user_by_id、internal_user.InternalUser.update_internal_user_by_name，

• 使用的路径为 post /ers/config/internaluser、delete /ers/config/internaluser/name/{name}、delete /ers/config/internaluser/{id}、put /ers/config/internaluser/name/{name}、put /ers/config/internaluser/{id}，

• 不支持 check_mode

• 插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器

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

示例

- name: Update by name
  cisco.ise.internal_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    changePassword: true
    customAttributes: {}
    description: string
    email: string
    enablePassword: string
    enabled: true
    expiryDate: string
    expiryDateEnabled: true
    firstName: string
    id: string
    identityGroups: string
    lastName: string
    name: string
    password: string
    passwordIDStore: string

- name: Delete by name
  cisco.ise.internal_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: string

- name: Update by id
  cisco.ise.internal_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    changePassword: true
    customAttributes: {}
    description: string
    email: string
    enablePassword: string
    enabled: true
    expiryDate: string
    expiryDateEnabled: true
    firstName: string
    id: string
    identityGroups: string
    lastName: string
    name: string
    password: string
    passwordIDStore: string

- name: Delete by id
  cisco.ise.internal_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.internal_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    changePassword: true
    customAttributes: {}
    description: string
    email: string
    enablePassword: string
    enabled: true
    expiryDate: string
    expiryDateEnabled: true
    firstName: string
    identityGroups: string
    lastName: string
    name: string
    password: string
    passwordIDStore: string

返回值

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表 返回：始终 示例： {"changePassword": true, "customAttributes": {}, "description": "string", "email": "string", "enablePassword": "string", "enabled": true, "expiryDate": "string", "expiryDateEnabled": true, "firstName": "string", "id": "string", "identityGroups": "string", "lastName": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "password": "string", "passwordIDStore": "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)

集合链接

• 问题追踪器
• 代码仓库