community.vmware.vmware_vc_infraprofile_info 模块 – 列出和导出 VMware vCenter 基础架构配置文件。

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在剧本中使用它,请指定: community.vmware.vmware_vc_infraprofile_info

概要

  • 用于管理 VMware vCenter 基础架构配置文件的模块。

  • vCenter 基础架构配置文件库功能在 vSphere 7.0 版本中引入,因此此模块在早期版本的 vSphere 中不受支持。

要求

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

  • vSphere 自动化 SDK

参数

参数

注释

api

字符串

需要执行的 API

选项

  • "export"

  • "import"

  • "list"

  • "validate"

config_path

字符串

包含基础架构配置文件 JSON 数据的配置文件路径,支持相对路径和绝对路径。

仅当使用 importvalidate API 时才需要此参数。

decryption_key

字符串

执行导入配置文件任务时的解密密钥参数,目前 API 团队没有考虑在内。

description

字符串

关于加密或解密密钥的描述。

encryption_key

字符串

执行导入配置文件任务时的加密密钥参数,目前 API 团队没有考虑在内。

hostname

字符串

vSphere vCenter 服务器的主机名或 IP 地址。

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

password

别名:pass,pwd

字符串

vSphere vCenter 服务器的密码。

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

port

整数

vSphere vCenter 的端口号。

如果任务中未指定值,则将使用环境变量 VMWARE_PORT 的值。

默认值: 443

profiles

字符串

要导出、导入和验证的配置文件名称列表。

运行 List API 时不需要此参数,exportimportvalidate 也不需要。

protocol

字符串

连接协议。

选项

  • "http"

  • "https" ← (默认)

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式为主机名或 IP。

如果任务中未指定值,则将使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果任务中未指定值,则将使用环境变量VMWARE_PROXY_PORT的值。

用户名

别名:admin,user

字符串

vSphere vCenter 服务器的用户名。

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

validate_certs

布尔值

允许在SSL证书无效时连接。

当证书不受信任时,设置为false

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

示例

- name: Get information about VC infraprofile
  vmware_vc_infraprofile_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost

- name: export vCenter appliance infra profile config
  vmware_vc_infraprofile_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    api: "export"
    profiles: "ApplianceManagement"
  delegate_to: localhost

- name: validate vCenter appliance infra profile config
  vmware_vc_infraprofile_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    api: "validate"
    profiles: "ApplianceManagement"
    config_path: "export.json"

- name: import vCenter appliance infra profile config
  vmware_vc_infraprofile_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    api: "import"
    profiles: "ApplianceManagement"
    config_path: "import.json"
  delegate_to: localhost

返回值

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

描述

export_infra

字典

关于导出文件的说明

返回值:API设置为“export”时成功

示例: {"export_config_json": "json exported to file"}

import_profile

字典

关于import_profile规范导入的说明

返回值:API设置为“import”时成功

示例: {"changed": true, "failed": false, "status": "0.0"}

list_infra

列表 / 元素=字符串

基础架构配置列表

返回值:API为“list”时成功

示例: [{"info": "ApplianceManagement", "name": "ApplianceManagement"}, {"info": "ApplianceNetwork", "name": "ApplianceNetwork"}, {"info": "Authentication & Authorization Management", "name": "AuthManagement"}]

validate_infra

字典

关于导出文件验证的说明

返回值:API设置为“validate”时成功

示例: {"changed": false, "failed": false, "status": "VALID"}

作者

  • Naveenkumar G P (@ngp)