powercli-bridge

HTTPS is now default, with a self signed cert.

Description

Currently this connects to a vCenter, configures DRS/HA/vCLS for shutdown.

Cycles through running VMs and shuts them down or alternately powers them off (hard)

Then hosts that are not running the vCenter VM are put into Maintenance Mode, before it finally directly connects to the host running vCenter and places it in Maintenance Mode while shutting down vCenter.

The ESXi host running vCenter is stored in a state file so that it can be picked up again by a future startup action.

How to run

Option 1: Container

Download the pre-configured container and run it.

Option 2: Run in PowerShell/PowerCLI

Option 2a: Automatically install and configure required Powershell modules (PowerCLI and Pode)

Run installer.ps1 to automatically install PowerCLI and Pode Powershell modules.

Option 2b: Manually install and configure required Powershell modules (PowerCLI and Pode)

Set-PSRepository -Name 'PSGallery' -InstallationPolicy Trusted
Install-Module VMware.PowerCLI -Scope AllUsers
Set-PowerCLIConfiguration -Scope AllUsers -ParticipateInCEIP \$false -Confirm:\$false | Out-Null
Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Confirm:\$false | Out-Null
Install-Module -Name Pode -Scope AllUsers

Edit setenv.ps1.example and replace the values with the real values from your environment. Rename the file to setenv.ps1. Run wrapper.ps1 set the required environment variables, and start the Pode server.

shutdown.ps1

Only thing available as of now. More to come?

setenv.ps1.example

$Env:vCenterVMName='vCenter VM Name'
$Env:vCenterServerFQDN='vCenter FQDN'
$Env:vCenterUsername='vCenter Username'
$Env:vCenterPassword='vCenter User Password'
$Env:ESXiHostUsername='ESXi host username'
$Env:ESXiHostPassword='ESXi host password'
$env:X_PODE_API_KEY = '12345678910'

REST API Example Usage

curl --location 'https://localhost:8085/api/v1/ups/shutdown' \
--header 'X-API-KEY: <your api key>'

Environment Variables Required

vSphere Related

ENV Variable	Description
vCenterVMName	vCenter VM name - used to exclude the vCenter VM in the shutdown procedure
vCenterServerFQDN	vCenter FQDN name, used for the PowerCLI connection
vCenterUsername	vCenter username, ex. `administrator@vsphere.local`
vCenterPassword	vCenter password
ESXiHostUsername	ESXi host username, default `root`
ESXiHostPassword	ESXi host password

PODE / REST API Related

ENV Variable	Description
X_PODE_API_KEY	API Key

X_PODE_API_KEY is any key you want to use. Can for instance be generated with API Key Generator

States

Current configuration is saved in /states/shutdown_state.json, for use later e.g a startup action or similar

State is saved for:

Execution Time
HA Status
DRS Level
vCLS Mode
vCenter Host (Which host was the vCenter running on when shutdown was performed)

Flowchart


flowchart TD
style E fill:#F3522F,stroke:#333,stroke-width:2px

    A[Start] --> B(Connect to vCenter);
    B --> C{Check Environment};
    C --> D[vSAN] --> E[TODO];
    C --> F[No vSAN] --> G[DRS Level];
    G --> H[HA Status];
    H --> I[vCLS Retreat Mode];
    I --> J[Shut down powered on VMs];
    J --> K[Shutdown];
    J --> L[Force];
    K --> M[Shut Down VM second pass];
    L --> M[Shut Down VM second pass];
    M --> O[Force Remaining VMs];
    O --> P[Check vCenter VM Host];
    P --> Q[Hosts Maintenance Mode];
    Q --> R[Connect vCenter Host];
    R --> S[vCenter Host Maintenance Mode];
    S --> T[Shut down vCenter VM];
    T --> U[vCenter Host Maintenance Mode];
    U --> V[Completed];

h0bbel / powercli-bridge

readme