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 
参数
| 参数 | 注释 | 
|---|---|
| 筛选查询参数。**简单筛选**应该可以通过筛选查询字符串参数获得。筛选器的结构是一个由点分隔的字段运算符和值的三元组。可以发送多个筛选器。所有筛选条件通用的逻辑运算符默认将是 AND,并且可以通过使用 “filterType=or” 查询字符串参数进行更改。 每个资源数据模型描述都应指定某个属性是否为筛选字段。 “EQ”运算符描述“等于”。 “NEQ”运算符描述“不等于”。 “GT”运算符描述“大于”。 “LT”运算符描述“小于”。 “STARTSW”运算符描述“以...开始”。 “NSTARTSW”运算符描述“不以...开始”。 “ENDSW”运算符描述“以...结束”。 “NENDSW”运算符描述“不以...结束”。 “CONTAINS”运算符描述“包含”。 “NCONTAINS”运算符描述“不包含”。 | |
| FilterType 查询参数。所有筛选条件通用的逻辑运算符默认将是 AND,并且可以使用该参数进行更改。 | |
| ID 路径参数。 | |
| 用于启用 Identity Services Engine SDK 调试的标志。 选择 
 | |
| Identity Services Engine 主机名。 | |
| 用于进行身份验证的 Identity Services Engine 密码。 | |
| RESTful HTTP 请求的超时时间(以秒为单位)。 默认值:  | |
| 用于进行身份验证的 Identity Services Engine 用户名。 | |
| 一个标志,用于通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API。 如果为 True,则 SDK 假设您的 ISE CSRF 检查已启用。 如果为 True,则它假设您需要 SDK 为您自动管理 CSRF 令牌。 选择 
 | |
| 用于启用或禁用 SSL 证书验证的标志。 选择 
 | |
| 通知 SDK 要使用的 Identity Services Engine 版本。 默认值:  | |
| 用于启用 Identity Services Engine SDK 自动速率限制处理的标志。 选择 
 | |
| 页面查询参数。页码。 | |
| 大小查询参数。每页返回的对象数。 | |
| Sortasc 查询参数。升序排序。 | |
| 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
返回值
常见的返回值在这里文档中有所描述,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 一个字典或列表,包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例:  | |
| 一个字典或列表,包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例:  | 
