You can manually edit the configuration settings for a cluster by using the configuration document and the configuration schema available for the current configuration and for the draft configuration of the cluster.

What Are the Configuration Schema and the Configuration Document

You set up and manage the desired host configuration for an entire cluster by working with the configuration document for the respective cluster. The configuration document is a JSON file that you can download to your local machine and edit with a JSON editor tool.

Starting with vSphere 8.0 Update 2, you no longer need to download the configuration document to edit it. Instead, you can directly edit the current cluster configuration in the vSphere Client. You create a working copy of the cluster configuration, called a draft, edit the configuration settings, and apply your changes to the cluster in a single operation. For more information, see Edit the Host Settings of a Draft Configuration in vSphere Client.

A valid configuration document contains a profile section and, optionally, a host-specific and host-override sections.

  • The profile section contains common configuration that is applicable to all hosts in the cluster.

  • The host-specific section represents configuration that can only be specified per host.

  • The host-override section represents configuration that is overridden for a specific host in the cluster.

The configuration document is backed by a JSON schema, which is not editable. The configuration schema is a JSON file that represents the complete ESXi configuration. The schema follows the JSON Schema format and contains the default values for all host properties. The configuration schema is generated from the desired software specification defined in the image for the cluster. The configuration schema changes when you change the software specification for the cluster.

Export the Cluster Configuration or Cluster Configuration Schema

You can export the current cluster configuration in the form of a JSON file, which you can manually edit. You can also export the configuration schema for the cluster and use it to help you create your own configuration document from scratch or edit an exported configuration document.

Prerequisites

Procedure

  1. In the vSphere Client, navigate to a cluster that you manage with a single image.
  2. On the Configure tab, click Desired State > Configuration.
  3. On the Settings tab, select your task.
    • To download the current configuration for the cluster, from the Export drop-down menu, click Cluster configuration.
    • To download the configuration schema for the cluster, from the Export drop-down menu, click Cluster configuration schema.
    A dialog box appears that prompts you to download the JSON file that contains the current cluster configuration or the configuration schema.
  4. Click Download.

Results

The current configuration document or the configuration schema is saved locally on your machine.

What to do next

Edit the configuration document or use the configuration schema to create a new JSON file with the desired host configuration for the cluster. Then, import the newly created or edited configuration document into the cluster.

Export the Draft Cluster Configuration or Draft Cluster Configuration Schema

You can export the draft cluster configuration in the form of a JSON file and manually edit it. You can also export the draft configuration schema for the cluster and use it to help you create your own configuration document from scratch or edit an exported configuration document.

Prerequisites

  • Verify that vCenter Server is of version 8.0 Update 2 or later.
  • Verify that ESXi is of version 8.0 Update 1 or later.
  • Verify that you have the required license.
  • Verify that you have a working copy of the configuration created for the cluster.
  • Verify that you have the required privileges for the export operation. See Required Privileges for Using vSphere Configuration Profiles.

Procedure

  1. In the vSphere Client, navigate to a cluster that you manage with a single image.
  2. On the Configure tab, click Desired State > Configuration.
  3. On the Draft tab, select your task.
    • To download the current draft configuration document for the cluster, click the horizontal ellipses icon and select Export.
    • To download the draft configuration schema for the cluster, click the horizontal ellipses icon and select Export configuration schema.
    A dialog box appears that prompts you to download the JSON file that contains the current draft cluster configuration or the draft configuration schema.
  4. Click Download.

Results

The current draft configuration document or the draft configuration schema is saved locally on your machine.

What to do next

Edit the draft configuration document or use the draft configuration schema to create a new JSON file with the desired host configuration for the cluster. Then, import the newly created or edited draft configuration document into the cluster.

Extract The Configuration from a Reference Host

You can extract the configuration of any host in the vCenter Server inventory. The configuration is saved on your local machine as a JSON file, which you can edit. You can import the extracted configuration into any other cluster that has vSphere Configuration Profiles enabled.

Prerequisites

  • Verify that vCenter Server is of version 8.0 Update 1 or later.
  • Verify that ESXi is of version 8.0 Update 1 or later.
  • Verify that you have the required license.
  • Verify that you have the required privileges for the extract operation. See Required Privileges for Using vSphere Configuration Profiles.

Procedure

  1. In the vSphere Client, navigate to a cluster that you manage with a single image.
  2. On the Configure tab, click Desired State > Configuration.
  3. On the Settings tab, click the Export drop-down menu and select Reference host configuration.
    The Export Configuration wizard opens.
  4. Follow the prompts to download the configuration of the selected reference host.
    You can activate the Show hosts from existing cluster toggle to narrow down the list of hosts available in your vCenter Server to only the hosts available in the selected cluster.

Results

The configuration of a selected reference host is exported and downloaded to your local machine as a JSON file.

What to do next

Import the downloaded JSON configuration into another cluster to reuse the configuration. Alternatively, you can also edit the downloaded file first and then import it into the same or different cluster.