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
参数
参数 |
注释 |
---|---|
必须包含网络才能与过滤器匹配的数据中心。 如果未设置或为空,则任何数据中心中的网络都与过滤器匹配。 当客户端将此结构的值作为参数传递时,该字段必须包含由 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。 |
|
必须包含网络才能与过滤器匹配的文件夹。 如果未设置或为空,则任何文件夹中的网络都与过滤器匹配。 当客户端将此结构的值作为参数传递时,该字段必须包含由 vmware.vmware_rest.vcenter_folder_info 返回的资源的 ID。 |
|
网络必须具有才能与过滤器匹配的名称(请参阅名称)。 如果未设置或为空,则任何名称的网络都与过滤器匹配。 |
|
可以与过滤器匹配的网络的标识符。 如果未设置或为空,则任何标识符的网络都与过滤器匹配。 当客户端将此结构的值作为参数传递时,该字段必须包含由 vmware.vmware_rest.vcenter_network_info 返回的资源的 ID。 |
|
客户端会话的超时设置。 整个操作(包括连接建立、请求发送和响应)的最长时间(秒)。 默认值为 300 秒。 |
|
网络必须具有才能与过滤器匹配的类型(请参阅类型)。 如果未设置,则任何类型的网络都与过滤器匹配。 |
|
vSphere vCenter 的主机名或 IP 地址 如果未在任务中指定该值,则将使用环境变量 |
|
vSphere vCenter 密码 如果未在任务中指定该值,则将使用环境变量 |
|
您可以使用此可选参数来设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果未在任务中指定该值,则将使用 环境变量 |
|
vSphere vCenter 用户名 如果未在任务中指定该值,则将使用环境变量 |
|
允许在 SSL 证书无效时进行连接。当证书不受信任时,设置为 如果未在任务中指定该值,则将使用环境变量 选项
|
注释
注意
在 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
返回值
常见的返回值记录在此处 这里,以下是此模块特有的字段。
键 |
描述 |
---|---|
获取网络列表 返回: 成功时 示例: |