vmware.vmware_rest.vcenter_network_info 模块 – 返回 vCenter 中最多 1000 个可见（受权限检查约束）的、与 Network.FilterSpec 匹配的网络信息。

注意

此模块是 vmware.vmware_rest 集合（版本 4.3.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install vmware.vmware_rest。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：vmware.vmware_rest.vcenter_network_info。

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 返回 vCenter 中最多 1000 个可见（受权限检查约束）的、与 Network.FilterSpec 匹配的网络的信息。

要求

执行此模块的主机需要满足以下要求。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

datacenters

别名：filter_datacenters

列表 / 元素=字符串

数据中心，必须包含网络才能使网络匹配过滤器。

如果未设置或为空，则任何数据中心中的网络都将匹配过滤器。

当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_datacenter_info 返回的资源 ID。

folders

别名：filter_folders

列表 / 元素=字符串

文件夹，必须包含网络才能使网络匹配过滤器。

如果未设置或为空，则任何文件夹中的网络都将匹配过滤器。

当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_folder_info 返回的资源 ID。

names

别名：filter_names

列表 / 元素=字符串

网络必须具有的名称才能匹配过滤器（请参见name）。

如果未设置或为空，则任何名称的网络都将匹配过滤器。

networks

列表 / 元素=字符串

可以匹配过滤器的网络的标识符。

如果未设置或为空，则任何标识符的网络都将匹配过滤器。

当客户端将此结构的值作为参数传递时，该字段必须包含 vmware.vmware_rest.vcenter_network_info 返回的资源 ID。

session_timeout

浮点数

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

包括连接建立、请求发送和响应在内的整个操作的最大秒数。

默认值为 300 秒。

types

别名：filter_types

列表 / 元素=字符串

网络必须具有的类型才能匹配过滤器（请参见type）。

如果未设置，则任何类型的网络都将匹配过滤器。

vcenter_hostname

字符串 / 必需

vSphere vCenter 的主机名或 IP 地址

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

vcenter_password

字符串 / 必需

vSphere vCenter 密码

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

vcenter_rest_log_file

字符串

您可以使用此可选参数来设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行模块的主机上。

如果任务中未指定该值，则将使用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

字符串 / 必需

vSphere vCenter 用户名

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

vcenter_validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Get the dvswitch called my-portgroup
  vmware.vmware_rest.vcenter_network_info:
    filter_types: DISTRIBUTED_PORTGROUP
    filter_names: my portrgoup
  register: my_portgroup

返回值

常见的返回值记录在 这里，以下是此模块独有的字段

键

描述

值

列表 / 元素=字符串

获取网络列表

返回：成功时

示例: [{"name": "VM 网络", "network": "network-1016", "type": "STANDARD_PORTGROUP"}, {"name": "second_vswitch", "network": "network-1018", "type": "STANDARD_PORTGROUP"}, {"name": "dvswitch1-DVUplinks-1020", "network": "dvportgroup-1021", "type": "DISTRIBUTED_PORTGROUP"}, {"name": "my portrgoup", "network": "dvportgroup-1022", "type": "DISTRIBUTED_PORTGROUP"}]

作者

  • Ansible 云团队 (@ansible-collections)