cisco.ise.sg_to_vn_to_vlan 模块 – SG 到 VN 到 VLAN 的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新功能

概要 

管理资源 SG 到 VN 到 VLAN 的创建、更新和删除操作。
此 API 创建一个安全组到虚拟网络。
此 API 删除一个安全组 ACL 到虚拟网络。
此 API 允许客户端更新一个安全组到虚拟网络。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
描述字符串	SG 到 VN 到 VLAN 的描述。
id 字符串	SG 到 VN 到 VLAN 的 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` ←（默认）
名称字符串	SG 到 VN 到 VLAN 的名称。
sgtId 字符串	SG 到 VN 到 VLAN 的 sgtId。
virtualnetworklist 列表 / 元素=字典	SG 到 VN 到 VLAN 的 virtualnetworklist。
defaultVirtualNetwork 布尔值	DefaultVirtualNetwork 标志。选项 `false` `true`
描述字符串	SG 到 VN 到 VLAN 的描述。
id 字符串	SG 到 VN 到 VLAN 的 ID。
名称字符串	SG 到 VN 到 VLAN 的名称。
vlans 列表 / 元素=字典	SG 到 VN 到 VLAN 的 vlans。
data 布尔值	数据标志。选项 `false` `true`
defaultVLAN 布尔值	DefaultVLAN 标志。选项 `false` `true`
描述字符串	SG 到 VN 到 VLAN 的描述。
id 字符串	SG 到 VN 到 VLAN 的 ID。
maxValue 整数	SG 到 VN 到 VLAN 的 maxValue。
名称字符串	SG 到 VN 到 VLAN 的名称。

注释 

注意

使用的 SDK 方法是 security_group_to_virtual_network.SecurityGroupToVirtualNetwork.create_security_groups_to_vn_to_vlan、security_group_to_virtual_network.SecurityGroupToVirtualNetwork.delete_security_groups_to_vn_to_vlan_by_id、security_group_to_virtual_network.SecurityGroupToVirtualNetwork.update_security_groups_to_vn_to_vlan_by_id，
使用的路径是 post /ers/config/sgtvnvlan、delete /ers/config/sgtvnvlan/{id}、put /ers/config/sgtvnvlan/{id}，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅 

另请参阅

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

示例 

- name: Update by id
  cisco.ise.sg_to_vn_to_vlan:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    sgtId: string
    virtualnetworklist:
    - defaultVirtualNetwork: true
      description: string
      id: string
      name: string
      vlans:
      - data: true
        defaultVlan: true
        description: string
        id: string
        maxValue: 0
        name: string

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

- name: Create
  cisco.ise.sg_to_vn_to_vlan:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    sgtId: string
    virtualnetworklist:
    - defaultVirtualNetwork: true
      description: string
      id: string
      name: string
      vlans:
      - data: true
        defaultVlan: true
        description: string
        id: string
        maxValue: 0
        name: string

返回值 

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

键

描述

ise_response

字典

由 Cisco ISE Python SDK 返回的响应的字典或列表

返回： 总是

示例: {"description": "字符串", "id": "字符串", "link": {"href": "字符串", "rel": "字符串", "type": "字符串"}, "name": "字符串", "sgtId": "字符串", "virtualnetworklist": [{"defaultVirtualNetwork": true, "description": "字符串", "id": "字符串", "name": "字符串", "vlans": [{"data": true, "defaultVlan": true, "description": "字符串", "id": "字符串", "maxValue": 0, "name": "字符串"}]}]}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

由 Cisco ISE Python SDK 返回的响应的字典或列表

返回： 总是

示例: {"UpdatedFieldsList": {"field": "字符串", "newValue": "字符串", "oldValue": "字符串", "updatedField": [{"field": "字符串", "newValue": "字符串", "oldValue": "字符串"}]}}

作者

Rafael Campos (@racampos)