community.vmware.vmware_vswitch_info 模块 – 收集有关 ESXi 主机的 vSwitch 配置的信息

注意

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

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

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

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

概要

  • 当给定 ESXi 主机名或集群名称时,可以使用此模块收集有关 ESXi 主机的 vSwitch 配置的信息。

  • vSphere Client 从 vSphere 5.5 及更高版本中将端口数的值显示为弹性。

  • 其他工具(如 esxcli)可能会将端口数显示为 1536 或 5632。

  • 有关更多详细信息,请参阅 https://kb.vmware.com/s/article/2064511

参数

参数

注释

cluster_name

字符串

集群的名称。

将返回此集群下每个 ESXi 主机系统的 vswitch 的信息。

如果未给出 esxi_hostname,则此参数是必需的。

esxi_hostname

字符串

从中收集信息的 ESXi 主机名。

如果未给出 cluster_name,则此参数是必需的。

hostname

字符串

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

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

password

别名:pass, pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

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

policies

布尔值

收集有关安全、流量整形以及团队和故障转移的信息。

属性 ts 表示流量整形,lb 表示负载平衡。

选择

  • false ←(默认)

  • true

port

整数

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

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

默认值: 443

proxy_host

字符串

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

格式是主机名或 IP。

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

proxy_port

整数

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

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

username

别名:admin, user

字符串

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

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

validate_certs

布尔值

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

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

选择

  • false

  • true ← (默认)

注意

注意

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

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

示例

- name: Gather vswitch info about all ESXi Host in given Cluster
  community.vmware.vmware_vswitch_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    delegate_to: localhost
  register: all_hosts_vswitch_info

- name: Gather vswitch info about ESXi Host
  community.vmware.vmware_vswitch_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    delegate_to: localhost
  register: all_vswitch_info

返回值

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

描述

hosts_vswitch_info

字典

有关主机 vSwitch 配置的元数据

返回: 成功时

示例: {"10.76.33.218": {"vSwitch0": {"failback": true, "failover_active": ["vmnic0"], "failover_standby": [], "failure_detection": "link_status_only", "lb": "loadbalance_srcid", "mtu": 1500, "notify": true, "num_ports": 128, "pnics": ["vmnic0"], "security": [false, false, false], "ts": false}, "vSwitch_0011": {"failback": true, "failover_active": ["vmnic1"], "failover_standby": ["vmnic2"], "failure_detection": "link_status_only", "lb": "loadbalance_srcid", "mtu": 1500, "notify": true, "num_ports": 128, "pnics": ["vmnic2", "vmnic1"], "security": [false, false, false], "ts": false}}}

作者

  • Abhijeet Kasurde (@Akasurde)