cisco.ise.active_directory_info 模块 – Active Directory 信息模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.ise.active_directory_info

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有 Active Directory。

  • 按 ID 获取 Active Directory。

  • 按名称获取 Active Directory。

  • 此 API 允许客户端按名称获取 Active Directory。

  • 此 API 按 ID 获取加入点详细信息。ID 可以使用检索。

  • 此 API 列出 Cisco ISE 中 Active Directory 域的所有加入点。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

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 网关发送请求的标志。

如果为 true,它将使用 ISE 的 API 网关并将请求发送到 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 ←(默认)

name

字符串

名称路径参数。

page

整数

页面查询参数。页码。

size

整数

大小查询参数。每页返回的对象数。

注释

注意

  • 使用的 SDK 方法是 active_directory.ActiveDirectory.get_active_directory_by_id、active_directory.ActiveDirectory.get_active_directory_by_name、active_directory.ActiveDirectory.get_active_directory_generator、

  • 使用的路径是 get /ers/config/activedirectory、get /ers/config/activedirectory/name/{name}、get /ers/config/activedirectory/{id}、

  • 支持 check_mode

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

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

示例

- name: Get all Active Directory
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Active Directory by id
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Active Directory by name
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

返回值

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

描述

ise_response

字典

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

已返回: 始终

示例: {"adAttributes": {"attributes": [{"defaultValue": "string", "internalName": "string", "name": "string", "type": "string"}]}, "adScopesNames": "string", "adgroups": {"groups": [{"name": "string", "sid": "string", "type": "string"}]}, "advancedSettings": {"agingTime": 0, "authProtectionType": "string", "country": "string", "department": "string", "email": "string", "enableCallbackForDialinClient": true, "enableDialinPermissionCheck": true, "enableFailedAuthProtection": true, "enableMachineAccess": true, "enableMachineAuth": true, "enablePassChange": true, "enableRewrites": true, "failedAuthThreshold": 0, "firstName": "string", "identityNotInAdBehaviour": "string", "jobTitle": "string", "lastName": "string", "locality": "string", "organizationalUnit": "string", "plaintextAuth": true, "rewriteRules": [{"rewriteMatch": "string", "rewriteResult": "string", "rowId": 0}], "schema": "string", "stateOrProvince": "string", "streetAddress": "string", "telephone": "string", "unreachableDomainsBehaviour": "string"}, "description": "string", "domain": "string", "enableDomainAllowedList": true, "enableDomainWhiteList": true, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

已返回: 始终

示例: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"domain\": \"string\",\n    \"enableDomainWhiteList\": true,\n    \"enableDomainAllowedList\": true,\n    \"adgroups\": {\n      \"groups\": [\n        {\n          \"name\": \"string\",\n          \"sid\": \"string\",\n          \"type\": \"string\"\n        }\n      ]\n    },\n    \"advancedSettings\": {\n      \"enablePassChange\": true,\n      \"enableMachineAuth\": true,\n      \"enableMachineAccess\": true,\n      \"agingTime\": 0,\n      \"enableDialinPermissionCheck\": true,\n      \"enableCallbackForDialinClient\": true,\n      \"plaintextAuth\": true,\n      \"enableFailedAuthProtection\": true,\n      \"authProtectionType\": \"string\",\n      \"failedAuthThreshold\": 0,\n      \"identityNotInAdBehaviour\": \"string\",\n      \"unreachableDomainsBehaviour\": \"string\",\n      \"enableRewrites\": true,\n      \"rewriteRules\": [\n        {\n          \"rowId\": 0,\n          \"rewriteMatch\": \"string\",\n          \"rewriteResult\": \"string\"\n        }\n      ],\n      \"firstName\": \"string\",\n      \"department\": \"string\",\n      \"lastName\": \"string\",\n      \"organizationalUnit\": \"string\",\n      \"jobTitle\": \"string\",\n      \"locality\": \"string\",\n      \"email\": \"string\",\n      \"stateOrProvince\": \"string\",\n      \"telephone\": \"string\",\n      \"country\": \"string\",\n      \"streetAddress\": \"string\",\n      \"schema\": \"string\"\n    },\n    \"adAttributes\": {\n      \"attributes\": [\n        {\n          \"name\": \"string\",\n          \"type\": \"string\",\n          \"internalName\": \"string\",\n          \"defaultValue\": \"string\"\n        }\n      ]\n    },\n    \"adScopesNames\": \"string\",\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)