community.vmware.vmware_dvswitch_pvlans 模块 – 管理分布式交换机的私有 VLAN 配置

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定: community.vmware.vmware_dvswitch_pvlans

概要

  • 此模块可用于配置分布式交换机上的私有 VLAN (PVLAN)。

参数

参数

注释

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果任务中未指定此值,则将使用环境变量 VMWARE_HOST 的值。

password

别名:pass、pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

如果任务中未指定此值,则将使用环境变量 VMWARE_PASSWORD 的值。

port

整数

vSphere vCenter 或 ESXi 服务器的端口号。

如果任务中未指定此值,则将使用环境变量 VMWARE_PORT 的值。

默认值: 443

primary_pvlans

列表 / 元素=字典

应配置为主要 PVLAN 的 VLAN ID 列表。

如果未指定,则如果存在,将删除所有 PVLAN。

列表中的每个成员都需要设置 primary_pvlan_id (int)。

次要混杂 PVLAN 将自动创建。

如果未指定 secondary_pvlans,则将创建主要 PVLAN 和每个次要混杂 PVLAN。

请参阅示例以了解更多信息。

默认值: []

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式为主机名或 IP。

如果任务中未指定此值,则将使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果任务中未指定此值,则将使用环境变量 VMWARE_PROXY_PORT 的值。

secondary_pvlans

列表 / 元素=字典

应配置为次要 PVLAN 的 VLAN ID 列表。

需要指定 primary_pvlans 才能创建任何次要 PVLAN。

如果未指定 primary_pvlans,则如果存在,将删除所有 PVLAN。

列表中的每个成员都需要设置 primary_pvlan_id (int)、secondary_pvlan_id (int) 和 pvlan_type (str)。

次要 PVLAN 的类型可以是隔离的或社区的。次要混杂 PVLAN 将自动创建。

请参阅示例以了解更多信息。

默认值: []

switch

别名:dvswitch

字符串 / 必需

分布式交换机的名称。

username

别名:admin、user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果任务中未指定此值,则将使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

允许在 SSL 证书无效时连接。当证书不受信任时,设置为 false

如果任务中未指定此值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

备注

注意

  • 所有模块都需要API写入权限,因此不受免费ESXi许可证支持。

  • 所有变量和VMware对象名称都区分大小写。

示例

- name: Create PVLANs on a Distributed Switch
  community.vmware.vmware_dvswitch_pvlans:
    hostname: '{{ inventory_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch: dvSwitch
    primary_pvlans:
      - primary_pvlan_id: 1
      - primary_pvlan_id: 4
    secondary_pvlans:
      - primary_pvlan_id: 1
        secondary_pvlan_id: 2
        pvlan_type: isolated
      - primary_pvlan_id: 1
        secondary_pvlan_id: 3
        pvlan_type: community
      - primary_pvlan_id: 4
        secondary_pvlan_id: 5
        pvlan_type: community
  delegate_to: localhost

- name: Create primary PVLAN and secondary promiscuous PVLAN on a Distributed Switch
  community.vmware.vmware_dvswitch_pvlans:
    hostname: '{{ inventory_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch: dvSwitch
    primary_pvlans:
      - primary_pvlan_id: 1
  delegate_to: localhost

- name: Remove all PVLANs from a Distributed Switch
  community.vmware.vmware_dvswitch_pvlans:
    hostname: '{{ inventory_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    switch: dvSwitch
    primary_pvlans: []
    secondary_pvlans: []
  delegate_to: localhost

返回值

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

描述

结果

字符串

有关已执行操作的信息

返回:始终

示例: "{'changed': True, 'dvswitch': 'dvSwitch', 'private_vlans': [{'primary_pvlan_id': 1, 'pvlan_type': 'promiscuous', 'secondary_pvlan_id': 1}, {'primary_pvlan_id': 1, 'pvlan_type': 'isolated', 'secondary_pvlan_id': 2}, {'primary_pvlan_id': 1, 'pvlan_type': 'community', 'secondary_pvlan_id': 3}], 'private_vlans_previous': [], 'result': 'All private VLANs added'}"

作者

  • Christian Kotte (@ckotte)