cisco.ise.filter_policy 模块 – 过滤器策略的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新功能

概要 

管理资源过滤器策略的创建、更新和删除操作。
此 API 创建一个过滤器策略。
此 API 删除一个过滤器策略。
此 API 允许客户端更新过滤器策略。

注意

此模块有一个对应的 action 插件。

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
domains 字符串	SXP 域的列表，用逗号分隔。
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 是否向 ISE 的 ERS API 发送 CSRF 令牌的标志。如果为 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` ←（默认）
sgt 字符串	SGT 名称或 ID。应至少定义一个子网、sgt 或 vn。
subnet 字符串	过滤器策略的子网（不支持主机名）。应至少定义一个子网、sgt 或 vn。
vn 字符串	虚拟网络。应至少定义一个子网、sgt 或 vn。

注释 

注意

使用的 SDK 方法是 filter_policy.FilterPolicy.create_filter_policy、filter_policy.FilterPolicy.delete_filter_policy_by_id、filter_policy.FilterPolicy.update_filter_policy_by_id，
使用的路径是 post /ers/config/filterpolicy、delete /ers/config/filterpolicy/{id}、put /ers/config/filterpolicy/{id}，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update by id
  cisco.ise.filter_policy:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    domains: string
    id: string
    sgt: string
    subnet: string
    vn: string

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

- name: Create
  cisco.ise.filter_policy:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    domains: string
    sgt: string
    subnet: string
    vn: string

返回值 

常见的返回值在这里有文档说明，以下是此模块特有的字段

键	描述
ise_response 字典	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应返回: 始终示例: `{"domains": "string", "sgt": "string", "subnet": "string", "vn": "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)