cisco.ise.trustsec_vn_vlan_mapping 模块 – Trustsec VN VLAN 映射的资源模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.ise.trustsec_vn_vlan_mapping。

cisco.ise 2.0.0 中的新增功能

概要

  • 管理资源 Trustsec VN VLAN 映射的创建、更新和删除操作。

  • 创建 VN-Vlan 映射。

  • 更新 VN-Vlan 映射。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

id

字符串

VN-VLAN 映射的标识符。

isData

布尔值

标志，指示 VLAN 是数据类型还是语音类型。

选项

  • false

  • true

isDefaultVLAN

布尔值

标志，指示 VLAN 是否为默认 VLAN。

选项

  • false

  • true

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 ← (默认)

lastUpdate

字符串

VN-VLAN 映射上次更新的时间戳。

maxValue

整数

最大值。

name

字符串

VLAN 的名称。

vnId

字符串

关联虚拟网络的标识符，除非提供其名称，否则是必需的。

vnName

字符串

关联虚拟网络的名称，用于标识（如果未提供 id）。

备注

注意

  • 使用的 SDK 方法是 vn_vlan_mapping.VnVlanMapping.create_vn_vlan_mapping、vn_vlan_mapping.VnVlanMapping.delete_vn_vlan_mapping、vn_vlan_mapping.VnVlanMapping.update_vn_vlan_mapping。

  • 使用的路径是 post /api/v1/trustsec/vnvlanmapping、delete /api/v1/trustsec/vnvlanmapping/{id}、put /api/v1/trustsec/vnvlanmapping/{id}。

  • 不支持 check_mode

  • 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅

另请参阅

有关 vnVlanMapping 的 Cisco ISE 文档

vnVlanMapping API 的完整参考。

示例

- name: Create
  cisco.ise.trustsec_vn_vlan_mapping:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    isData: true
    isDefaultVlan: true
    lastUpdate: string
    maxValue: 0
    name: string
    vnId: string
    vnName: string

- name: Update by id
  cisco.ise.trustsec_vn_vlan_mapping:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    isData: true
    isDefaultVlan: true
    lastUpdate: string
    maxValue: 0
    name: string
    vnId: string
    vnName: string

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

返回值

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

键

描述

ise_response

列表 / elements=字典

一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应

已返回：总是

示例： "[\n  {\n    \"id\": \"字符串\",\n    \"isData\": true,\n    \"isDefaultVlan\": true,\n    \"lastUpdate\": \"字符串\",\n    \"maxValue\": 0,\n    \"name\": \"字符串\",\n    \"vnId\": \"字符串\",\n    \"vnName\": \"字符串\"\n  }\n]\n"

ise_update_response

字典

一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应

已返回：总是

示例： {"message": "字符串"}

作者

  • Rafael Campos (@racampos)