cisco.ise.trustsec_vn_vlan_mapping_info 模块 – Trustsec VN VLAN 映射信息模块

注意

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

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

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

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

cisco.ise 2.0.0 中的新增功能

概要 

获取所有 Trustsec VN VLAN 映射。
按 ID 获取 Trustsec VN VLAN 映射。
按 ID 获取 VN-Vlan 映射。
获取所有 VN-Vlan 映射。

注意

此模块具有相应的操作插件。

要求 

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

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 我们是否向 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` ← (默认)
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数。
sort 字符串	排序查询参数。排序类型 - asc 或 desc。
sortBy 字符串	SortBy 查询参数。需要排序的对象的排序依据列。

注释 

注意

使用的 SDK 方法是 vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mapping_by_id、vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mapping_list_generator，
使用的路径是 get /api/v1/trustsec/vnvlanmapping、get /api/v1/trustsec/vnvlanmapping/{id}，
支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅 

另请参阅

有关 vnVlanMapping 的 Cisco ISE 文档: vnVlanMapping API 的完整参考。

示例 

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

作者

Rafael Campos (@racampos)