Initialize the Appliance by Using the Initialization API

The vSphere Integrated Containers appliance provides an API that allows you to initialize the appliance after deployment without having to manually enter information in the appliance welcome page. This API helps you to automate the deployment of appliances without manual intervention.

The appliance exposes the initialization API endpoint at https://vic_appliance_address:9443/register. If the vSphere Integrated Containers appliance was configured to expose the file server on a different port, 9443 is replaced with the appropriate port.


You deployed an instance of the vSphere Integrated Containers appliance without completing the Platform Services Controller registration wizard that appears when you first go to the vSphere Integrated Containers appliance welcome page.


  1. On your usual working system, create a file named payload.json, to include information about your vSphere environment.

    vCenter Server with an embedded Platform Services Controller:


    vCenter Server with an external Platform Services Controller:


  2. Run a curl command to pass the payload.json file to the initialization API endpoint.

    Copy the command as shown, replacing vic_appliance_address with the address of the appliance.

    curl -k -w '%{http_code}' -d @payload.json https://vic_appliance_address:9443/register
    If successful, you see the message operation complete 200.


The appliance initializes and registers with the Platforms Services Controller. After initialization, vSphere Integrated Containers services are available at https://vic_appliance_address:9443.


Here is an example of a completed payload.json file:


results matching ""

    No results matching ""