cisco.ise.trustsec_sg_vn_mapping_info 模块 – Trustsec SG VN 映射信息模块

注意

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

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

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

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

cisco.ise 2.0.0 中的新增功能

概要 

获取所有 Trustsec SG VN 映射。
按 ID 获取 Trustsec SG VN 映射。
按 ID 获取安全组和虚拟网络映射。
获取所有安全组和虚拟网络映射。

注意

此模块具有相应的 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 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` ← (默认)
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数量。
sort 字符串	排序查询参数。排序类型 - asc 或 desc。
sortBy 字符串	SortBy 查询参数。需要按其排序对象的列。

注释 

注意

使用的SDK方法为sg_vn_mapping.SgVnMapping.get_sg_vn_mapping_by_id, sg_vn_mapping.SgVnMapping.get_sg_vn_mapping_list_generator,
使用的路径为 get /api/v1/trustsec/sgvnmapping, get /api/v1/trustsec/sgvnmapping/{id},
支持 check_mode
该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco ISE SDK的嵌入式连接管理器。
以ise_开头的参数由Cisco ISE Python SDK用于建立连接。

另请参见 

另请参见

Cisco ISE 的 sgVnMapping 文档。: sgVnMapping API 的完整参考。

示例 

- name: Get all Trustsec SG VN Mapping
  cisco.ise.trustsec_sg_vn_mapping_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    sort: string
    sortBy: string
    filter: string
    filterType: string
  register: result

- name: Get Trustsec SG VN Mapping by id
  cisco.ise.trustsec_sg_vn_mapping_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 返回的响应的字典或列表。返回值：始终示例： `"[\n {\n \"id\": \"string\",\n \"lastUpdate\": \"string\",\n \"sgName\": \"string\",\n \"sgtId\": \"string\",\n \"vnId\": \"string\",\n \"vnName\": \"string\"\n }\n]\n"`
ise_responses 列表 / 元素=字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回值：始终示例： `"[\n {\n \"id\": \"string\",\n \"lastUpdate\": \"string\",\n \"sgName\": \"string\",\n \"sgtId\": \"string\",\n \"vnId\": \"string\",\n \"vnName\": \"string\"\n }\n]\n"`

作者

Rafael Campos (@racampos)