cisco.ise.sg_mapping_group_info 模块 – SG 映射组信息模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

获取所有 SG 映射组。
按 ID 获取 SG 映射组。
此 API 允许客户端获取所有 IP 到 SGT 的映射组。
此 API 允许客户端按 ID 获取 IP 到 SGT 的映射组。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
filter 列表 / 元素=字符串	筛选器查询参数。简单筛选应该可以通过筛选器查询字符串参数实现。筛选器的结构是由字段、运算符和值组成的三元组，它们用点号分隔。可以发送多个筛选器。默认情况下，所有筛选条件的逻辑运算符都是 AND，可以使用“filterType=or”查询字符串参数进行更改。每个资源数据模型描述都应指定属性是否为筛选字段。 ‘EQ’ 运算符表示‘等于’。 ‘NEQ’ 运算符表示‘不等于’。 ‘GT’ 运算符表示‘大于’。 ‘LT’ 运算符表示‘小于’。 ‘STARTSW’ 运算符表示‘以…开头’。 ‘NSTARTSW’ 运算符表示‘不以…开头’。 ‘ENDSW’ 运算符表示‘以…结尾’。 ‘NENDSW’ 运算符表示‘不以…结尾’。 ‘CONTAINS’ 运算符表示‘包含’。 ‘NCONTAINS’ 运算符表示‘不包含’。
filterType 字符串	FilterType 查询参数。默认情况下，所有筛选条件的逻辑运算符都是 AND，可以使用此参数进行更改。
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` ← (默认)
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数量。
sortasc 字符串	Sortasc 查询参数。升序排序。
sortdsc 字符串	Sortdsc 查询参数。降序排序。

备注 

注意

使用的SDK方法为ip_to_sgt_mapping_group.IpToSgtMappingGroup.get_ip_to_sgt_mapping_group_by_id, ip_to_sgt_mapping_group.IpToSgtMappingGroup.get_ip_to_sgt_mapping_group_generator,
使用的路径为 get /ers/config/sgmappinggroup, get /ers/config/sgmappinggroup/{id},
支持 check_mode
该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco ISE SDK的嵌入式连接管理器。
以ise_开头的参数由Cisco ISE Python SDK用于建立连接。

另请参阅 

另请参阅

Cisco ISE关于IPToSGTMappingGroup的文档: IPToSGTMappingGroup API的完整参考。

示例 

- name: Get all SG Mapping Group
  cisco.ise.sg_mapping_group_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get SG Mapping Group by id
  cisco.ise.sg_mapping_group_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

返回值 

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

键	描述
ise_response 字典	包含Cisco ISE Python SDK返回的响应的字典或列表。返回值：始终返回示例： `{"deployTo": "string", "deployType": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "sgt": "string"}`
ise_responses 列表 / 元素=字典在 cisco.ise 1.1.0 中添加	包含Cisco ISE Python SDK返回的响应的字典或列表。返回值：始终返回示例： `"[\n {\n \"name\": \"string\",\n \"sgt\": \"string\",\n \"deployTo\": \"string\",\n \"deployType\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

作者

Rafael Campos (@racampos)