vmware.vmware_rest.vcenter_datacenter_info 模块 – 获取与数据中心对应的数据中心信息。

注意

此模块是 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_datacenter_info

vmware.vmware_rest 0.1.0 中的新增功能

概要

  • 获取与数据中心对应的数据中心信息。

要求

在执行此模块的主机上需要以下要求。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

datacenter

string

数据中心的标识符。

该参数必须是由 vmware.vmware_rest.vcenter_datacenter_info 返回的资源的 ID。 使用 state=['get'] 时是必需的

datacenters

别名: filter_datacenters

list / elements=string

可以匹配过滤器的的数据中心的标识符。

如果未设置或为空,则任何标识符的数据中心都匹配过滤器。

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

folders

别名: filter_folders

list / elements=string

必须包含数据中心,数据中心才能匹配过滤器的文件夹。

如果未设置或为空,则任何文件夹中的数据中心都匹配过滤器。

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

names

别名: filter_names

list / elements=string

数据中心必须具有的名称才能匹配过滤器(请参阅 name)。

如果未设置或为空,则任何名称的数据中心都匹配过滤器。

session_timeout

float

在 vmware.vmware_rest 2.1.0 中添加

客户端会话的超时设置。

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

默认值为 300 秒。

vcenter_hostname

string / required

vSphere vCenter 的主机名或 IP 地址

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

vcenter_password

string / required

vSphere vCenter 密码

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

vcenter_rest_log_file

string

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

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

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

如果未在任务中指定该值,则将改为使用

环境变量 VMWARE_REST_LOG_FILE 的值。

vcenter_username

string / required

vSphere vCenter 用户名

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

vcenter_validate_certs

boolean

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

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

选择

  • false

  • true ← (默认)

备注

注意

  • 在 vSphere 7.0.3 上测试

示例

- name: Get a list of all the datacenters
  register: existing_datacenters
  vmware.vmware_rest.vcenter_datacenter_info:

- name: collect a list of the datacenters
  vmware.vmware_rest.vcenter_datacenter_info:
  register: my_datacenters

返回值

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

描述

list / elements=string

收集数据中心列表

返回: 成功时

示例: [{"datacenter": "datacenter-1001", "name": "my_dc"}]

作者

  • Ansible 云团队 (@ansible-collections)