Command Reference

The tables below provide the commands you may issue using the Commander PowerShell client to control the HA configuration.

Commands for AWS deployment

ActionCommandNotes

Get the node’s current state.

/webservices/services/rest/v2/configuration/state

This endpoint requires superuser permissions.

Check the Commander health status.

/webservices/services/rest/v2/active

No authentication required.

Activate the service.

/webservices/services/rest/v2/configuration/activate?quarantine=false

This endpoint requires superuser permissions.

Commands for vCenter deployment

ActionCommandNotes

Transition Commander from running in standby to fully operational.

Initialize-Configuration

You will be prompted to provide URL and credentials for the HA user.

Check if the Commander service is in the ready state.

$s = Get-SystemState $s.SystemStatus.serviceState

Result will be either ACTIVE or STANDBY to indicate the current node’s state.

Activate the service.

Invoke-Activate -quarantine $false