community.vmware.vmware_vspan_session 模块 – 创建或删除端口镜像会话。

注意

此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_vspan_session。

概要 

此模块可用于创建、删除或编辑不同类型的端口镜像会话。

参数 

参数	注释
description 字符串	会话的描述。
destination_port 字符串	接收镜像数据包的目标端口。此外，此属性值中指定的任何端口都不能与任何分布式端口镜像会话中的源端口匹配。
destination_vm 字典	使用此参数，可以将虚拟机的网卡添加到端口镜像会话。
name 字符串	虚拟机的名称。
nic_label 字符串	要使用的网络接口卡的标签。
enabled 布尔值	会话是否启用。选项 `false` `true` ← (默认值)
encapsulation_vlan_id 整数	用于封装镜像流量的 VLAN ID。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
mirrored_packet_length 整数	一个整数，描述要镜像的每个帧的长度。如果未设置，则会镜像整个帧。当使用者只查看报头时，将此属性设置为较小的值很有用。该值不能小于 60。
name 字符串 / 必需	会话的名称。
normal_traffic_allowed 布尔值	目标端口是否可以发送和接收“正常”流量。将其设置为 false 将使镜像端口仅用于镜像，而不是兼作普通访问端口。选项 `false` `true`
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
sampling_rate 整数	会话的采样率。如果其值为 n，则每 n 个数据包中镜像一个。有效值介于 1 到 65535 之间。
session_type 字符串	选择镜像类型。在 `encapsulatedRemoteMirrorSource` 会话中，可以使用分布式端口作为源实体，可以使用 IP 地址作为目标实体。在 `remoteMirrorDest` 会话中，可以使用 VLAN ID 作为源实体，可以使用分布式端口作为目标实体。在 `remoteMirrorSource` 会话中，可以使用分布式端口作为源实体，可以使用上行链路端口名称作为目标实体。在`dvPortMirror`会话中，分布式端口可以同时用作源实体和目标实体。选项 `"encapsulatedRemoteMirrorSource"` `"remoteMirrorDest"` `"remoteMirrorSource"` `"dvPortMirror"` ← (默认)
source_port_received 字符串	镜像接收到的数据包的源端口。
source_port_transmitted 字符串	镜像发送的数据包的源端口。
source_vm_received 字典	使用此参数，可以将虚拟机的网卡添加到端口镜像会话。
name 字符串	虚拟机的名称。
nic_label 字符串	要使用的网络接口卡的标签。
source_vm_transmitted 字典	使用此参数，可以将虚拟机的网卡添加到端口镜像会话。
name 字符串	虚拟机的名称。
nic_label 字符串	要使用的网络接口卡的标签。
state 字符串 / 必需	创建或删除会话。选项 `"present"` `"absent"`
strip_original_vlan 布尔值	是否去除原始VLAN标签。如果为false，则镜像流量将保留原始VLAN标签。如果`encapsulation_vlan_id`已设置且此属性为`false`，则帧将使用原始VLAN ID作为内部标签进行双标签标记。选项 `false` `true`
switch 别名：switch_name 字符串 / 必需	要添加或删除镜像会话的分布式vSwitch的名称。
username 别名：admin，user 字符串	vSphere vCenter或ESXi服务器的用户名。如果任务中未指定此值，则将使用环境变量`VMWARE_USER`的值。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定此值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认值)

备注 

注意

所有模块都需要API写入权限，因此在免费ESXi许可证上不支持。
所有变量和VMware对象名称都区分大小写。

示例 

- name: Create distributed mirroring session.
  community.vmware.vmware_vspan_session:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch_name: dvSwitch
    state: present
    name: Basic Session
    enabled: true
    description: "Example description"
    source_port_transmitted: 817
    source_port_received: 817
    destination_port: 815
  delegate_to: localhost

- name: Create remote destination mirroring session.
  community.vmware.vmware_vspan_session:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch_name: dvSwitch
    state: present
    name: Remote Session
    enabled: true
    description: "Example description"
    source_port_received: 105
    destination_port: 815
    session_type: "remoteMirrorDest"
  delegate_to: localhost

- name: Delete remote destination mirroring session.
  community.vmware.vmware_vspan_session:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch_name: dvSwitch
    state: absent
    name: Remote Session
  delegate_to: localhost

作者

Peter Gyorgy (@gyorgypeter)