community.vmware.vmware_portgroup_info 模块 – 收集有关 ESXi 主机端口组配置的信息

注意

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

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

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

要在剧本中使用它，请指定： community.vmware.vmware_portgroup_info。

概要 

此模块可用于在给出 ESXi 主机名或集群名时收集有关 ESXi 主机端口组配置的信息。

参数 

参数	注释
cluster_name 字符串	集群名称。将返回属于此集群名称的所有 hostsystem 的信息。如果未给出 `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 portgroup info about all ESXi Host in given Cluster
  community.vmware.vmware_portgroup_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
  delegate_to: localhost

- name: Gather portgroup info about ESXi Host system
  community.vmware.vmware_portgroup_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
  delegate_to: localhost

返回值 

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

键

描述

hosts_portgroup_info

字典

有关主机端口组配置的元数据

返回：成功时

示例： {"esx01": [{"failback": true, "failover_active": ["vmnic0", "vmnic1"], "failover_standby": [], "failure_detection": "link_status_only", "lb": "loadbalance_srcid", "notify": true, "portgroup": "Management Network", "security": [false, false, false], "ts": "No override", "vlan_id": 0, "vswitch": "vSwitch0"}, {"failback": true, "failover_active": ["vmnic2"], "failover_standby": ["vmnic3"], "failure_detection": "No override", "lb": "No override", "notify": true, "portgroup": "vMotion", "security": [false, false, false], "ts": "No override", "vlan_id": 33, "vswitch": "vSwitch1"}]}

作者

Abhijeet Kasurde (@Akasurde)
Christian Kotte (@ckotte)