cisco.ise.aci_settings 模块 – ACI 设置的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

管理 ACI 设置资源的操作更新。
此 API 允许客户端更新 ACI 设置。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
aci50 布尔值	启用 5.0 ACI 版本。选项 `false` `true`
aci51 布尔值	启用 5.1 ACI 版本。选项 `false` `true`
aciipaddress 字符串	ACI 域管理器 IP 地址。
acipassword 字符串	ACI 域管理器密码。
aciuserName 字符串	ACI 域管理器用户名。
adminName 字符串	ACI 集群管理员名称。
adminPassword 字符串	ACI 集群管理员密码。
allSXPDomain 布尔值	AllSXPDomain 标志。选项 `false` `true`
defaultSGtName 字符串	ACI 设置的 defaultSGtName。
enableACI 布尔值	启用 ACI 集成。选项 `false` `true`
enableDataPlane 布尔值	EnableDataPlane 标志。选项 `false` `true`
enableElementsLimit 布尔值	EnableElementsLimit 标志。选项 `false` `true`
id 字符串	资源 UUID 值。
ipAddressHostName 字符串	ACI 集群 IP 地址/主机名。
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` ← (默认值)
l3RouteNetwork 字符串	ACI 设置的 l3RouteNetwork。
maxNumIepgFromACI 整数	ACI 设置的 maxNumIepgFromACI。
maxNumSGtToACI 整数	ACI 设置的 maxNumSGtToACI。
specificSXPDomain 布尔值	SpecificSXPDomain 标志。选项 `false` `true`
specifixSXPDomainList 列表 / 元素=字符串	ACI 设置的 specifixSXPDomainList。
suffixToEpg 字符串	ACI 设置的 suffixToEpg。
suffixToSGt 字符串	ACI 设置的 suffixToSGt。
tenantName 字符串	ACI 设置的 tenantName。
untaggedPacketIepgName 字符串	ACI 设置的 untaggedPacketIepgName。

备注 

注意

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

示例 

- name: Update by id
  cisco.ise.aci_settings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    aci50: true
    aci51: true
    aciipaddress: string
    acipassword: string
    aciuserName: string
    adminName: string
    adminPassword: string
    allSxpDomain: true
    defaultSgtName: string
    enableAci: true
    enableDataPlane: true
    enableElementsLimit: true
    id: string
    ipAddressHostName: string
    l3RouteNetwork: string
    maxNumIepgFromAci: 0
    maxNumSgtToAci: 0
    specificSxpDomain: true
    specifixSxpDomainList:
    - string
    suffixToEpg: string
    suffixToSgt: string
    tenantName: string
    untaggedPacketIepgName: string

返回值 

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

键

描述

ise_response

字典

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

返回值：始终返回

示例： {"aci50": true, "aci51": true, "aciipaddress": "string", "acipassword": "string", "aciuserName": "string", "adminName": "string", "adminPassword": "string", "allSxpDomain": true, "defaultSgtName": "string", "enableAci": true, "enableDataPlane": true, "enableElementsLimit": true, "id": "string", "ipAddressHostName": "string", "l3RouteNetwork": "string", "maxNumIepgFromAci": 0, "maxNumSgtToAci": 0, "specificSxpDomain": true, "specifixSxpDomainList": ["string"], "suffixToEpg": "string", "suffixToSgt": "string", "tenantName": "string", "untaggedPacketIepgName": "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)