cisco.ise.px_grid_direct 模块 – Px Grid Direct 资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中新增

概要

• 管理 Px Grid Direct 资源的创建、更新和删除操作。

• PxGrid Direct - 配置 connectorconfig 信息。

• PxGrid Direct - 根据 ConnectorName 删除配置的 connectorConfig 信息。

• PxGrid Direct - 根据 ConnectorName 更新配置的 connectorConfig 信息。

注意

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

需求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
additionalProperties 字典	Px Grid Direct 的 additionalProperties。
attributes 字典	ConnectorName。
attributeMapping 列表 / 元素=字典	<p>功能名称列表</p>。
dictionaryAttribute 字符串	Px Grid Direct 的 dictionaryAttribute。
includeInDictionary 布尔值	IncludeInDictionary 标志。 选项 false true
jsonAttribute 字符串	Px Grid Direct 的 jsonAttribute。
correlationIdentifier 字符串	唯一标识符。
topLevelObject 字符串	JSON 的根级别。
uniqueIdentifier 字符串	唯一标识符。
versionIdentifier 字符串	版本唯一标识符。
connectorName 字符串	ConnectorName。
connectorType 字符串	连接器类型列表。
deltasyncSchedule 字典	Px Grid Direct 的 deltasyncSchedule。
interval 整数	运行间隔（小时）。
intervalUnit 字符串	间隔单位。
startDate 字符串	开始日期和时间。
description 字符串	描述。
enabled 布尔值	启用标志。 选项 false true
fullsyncSchedule 字典	Px Grid Direct 的 fullsyncSchedule。
interval 整数	运行间隔（小时）。
intervalUnit 字符串	间隔单位。
startDate 字符串	开始日期和时间。
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 ← (默认)
protocol 字符串	协议。
skipCertificateValidations 布尔值	SkipCertificateValidations 标志。 选项 false true
url 字典	Px Grid Direct 的 url。
authenticationType 字符串	身份验证类型列表。
bulkUrl 字符串	BulkUrl。
incrementalUrl 字符串	IncrementalUrl。
password 字符串	密码。
userName 字符串	用户名。

注释

注意

• 使用的 SDK 方法是 px_grid_direct.PxGridDirect.create_connector_config、px_grid_direct.PxGridDirect.delete_connector_config_by_connector_name、px_grid_direct.PxGridDirect.update_connector_config_by_connector_name，

• 使用的路径是 post /api/v1/pxgrid-direct/connector-config、delete /api/v1/pxgrid-direct/connector-config/{connectorName}、put /api/v1/pxgrid-direct/connector-config/{connectorName}，

• 不支持 check_mode

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

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

示例

- name: Create
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
      - dictionaryAttribute: string
        includeInDictionary: true
        jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string

- name: Update by name
  cisco.ise.px_grid_direct:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    additionalProperties: {}
    attributes:
      attributeMapping:
      - dictionaryAttribute: string
        includeInDictionary: true
        jsonAttribute: string
      correlationIdentifier: string
      topLevelObject: string
      uniqueIdentifier: string
      versionIdentifier: string
    connectorName: string
    connectorType: string
    deltasyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    description: string
    enabled: true
    fullsyncSchedule:
      interval: 0
      intervalUnit: string
      startDate: string
    protocol: string
    skipCertificateValidations: true
    url:
      authenticationType: string
      bulkUrl: string
      incrementalUrl: string
      password: string
      userName: string

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

返回值

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

键	描述
ise_response 字典	Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： {"connector": {"additionalProperties": {}, "attributes": {"attributeMapping": [{"dictionaryAttribute": "string", "includeInDictionary": true, "jsonAttribute": "string"}], "correlationIdentifier": "string", "topLevelObject": "string", "uniqueIdentifier": "string", "versionIdentifier": "string"}, "connectorName": "string", "connectorType": "string", "deltasyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "description": "string", "enabled": true, "fullsyncSchedule": {"interval": 0, "intervalUnit": "string", "startDate": "string"}, "protocol": "string", "skipCertificateValidations": true, "url": {"authenticationType": "string", "bulkUrl": "string", "incrementalUrl": "string", "password": "string", "userName": "string"}}}
ise_update_response 字符串 在 cisco.ise 1.1.0 中添加	Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： "\"'string'\"\n"

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 代码库 (源代码)