community.vmware.vmware_dvswitch_info 模块 – 收集 dvswitch 配置信息

注意

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

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

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

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

概要

• 此模块可用于收集有关 dvswitch 配置的信息。

参数

参数	注释
folder 字符串	指定要从中收集信息的 dvswitch 的文件夹位置。 示例 folder: /datacenter1/network folder: datacenter1/network folder: /datacenter1/network/folder1 folder: datacenter1/network/folder1 folder: /folder1/datacenter1/network folder: folder1/datacenter1/network folder: /folder1/datacenter1/network/folder2
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将使用环境变量 VMWARE_HOST 的值。
password 别名：pass、pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将使用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定该值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
properties 列表 / 元素=字符串	指定要检索的属性。 如果未指定，则检索所有属性（深度检索）。 结果以与 vsphere API 相同的结构返回。 示例 properties: [ “summary.name”, “summary.numPorts”, “config.maxMtu”, “overallStatus” ] 仅当 schema=vsphere 时有效。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。
schema 字符串	指定所需的输出模式。 “summary” 输出模式是模块的旧版输出 “vsphere” 输出模式是 vSphere API 类定义 选项 "summary" ← (默认) "vsphere"
switch_name 别名：switch、dvswitch 字符串	要查找的 dvswitch 的名称。 如果未指定 switch_name，则收集所有 dvswitch 信息。
username 别名：admin、user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，将其设置为 false。 如果任务中未指定值，则将改用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

注释

注意

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

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

示例

- name: Gather all registered dvswitch
  community.vmware.vmware_dvswitch_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  delegate_to: localhost
  register: dvswitch_info

- name: Gather info about specific dvswitch
  community.vmware.vmware_dvswitch_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    switch_name: DVSwitch01
  delegate_to: localhost
  register: dvswitch_info

- name: Gather info from folder about specific dvswitch
  community.vmware.vmware_dvswitch_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    folder: /datacenter1/network/F01
    switch_name: DVSwitch02
  delegate_to: localhost
  register: dvswitch_info

- name: Gather some info from a dvswitch using the vSphere API output schema
  community.vmware.vmware_dvswitch_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    schema: vsphere
    properties:
      - summary.name
      - summary.numPorts
      - config.maxMtu
      - overallStatus
    switch_name: DVSwitch01
  register: dvswitch_info

返回值

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

键

描述

distributed_virtual_switches 列表 / 元素=字符串

包含dvswitch及其信息的字典列表 返回值：始终返回 示例： [{"configure": {"folder": "network", "hosts": ["esxi-test-02.local", "esxi-test-01.local"], "settings": {"healthCheck": {"TeamingHealthCheckConfig": false, "VlanMtuHealthCheckConfig": false}, "netflow": {"activeFlowTimeout": 60, "collectorIpAddress": "", "collectorPort": 0, "idleFlowTimeout": 15, "internalFlowsOnly": false, "observationDomainId": 0, "samplingRate": 0, "switchIpAddress": null}, "privateVlan": [], "properties": {"administratorContact": {"contact": null, "name": null}, "advanced": {"maxMtu": 1500, "multicastFilteringMode": "legacyFiltering"}, "discoveryProtocol": {"operation": "listen", "protocol": "cdp"}, "general": {"ioControl": true, "name": "DVSwitch01", "numPorts": 10, "numUplinks": 1, "vendor": "VMware, Inc.", "version": "6.6.0"}}}}, "uuid": "50 30 99 9c a7 60 8a 4f-05 9f e7 b5 da df 8f 17"}]

作者

• sky-joker (@sky-joker)

收藏链接

• 问题追踪器
• 主页
• 代码库 (源代码)