AksHci PowerShell Reference

Commands to interact with Azure Kubernetes Service on Azure Stack HCI.

AksHci cmdlets

Cmdlet Description
Add-AksHciGmsaCredentialSpec Adds a credentials spec for gMSA deployments on a cluster.
Add-AksHciNode Add a new physical node to a deployment.
Disable-AksHciArcConnection Disables the Arc connection on an AKS on Azure Stack HCI cluster.
Disable-AksHciPreview Reverts AKS on Azure Stack HCI from a preview channel back to the stable channel.
Enable-AksHciArcConnection Enables the Arc connection for an AKS on Azure Stack HCI cluster.
Enable-AksHciPreview Updates AKS on Azure Stack HCI to a preview channel.
Get-AksHciBillingStatuss Get billing status for the Azure Kubernetes Service on Azure Stack HCI deployment.
Get-AksHciCluster List deployed clusters including the Azure Kubernetes Service host.
Get-AksHciClusterNetwork Retrieve virtual network settings by name, cluster name, or a list of all virtual network settings in the system.
Get-AksHciClusterUpdates Get the available upgrades for an Azure Kubernetes Service cluster.
Get-AksHciConfig List the current configuration settings for the Azure Kubernetes Service host.
Get-AksHciCredential Access your cluster using kubectl.
Get-AksHciEventLog Gets all the event logs from the AKS HCI PowerShell module.
Get-AksHciKubernetesVersion List available version for creating managed Kubernetes cluster.
Get-AksHciLogs Create a zipped folder with logs from all your pods.
Get-AksHciNodePool List the node pools in a Kubernetes cluster.
Get-AksHciProxySetting Retrieve a list or an individual proxy settings object.
Get-AksHciRegistration Get registration information for the Azure Kubernetes Service on Azure Stack HCI deployment.
Get-AksHciContainerStorage Get the information of the specified storage container.
Get-AksHciUpdates List available updates for Azure Kubernetes Service on Azure Stack HCI.
Get-AksHciVersion Get the current version of Azure Kubernetes Service on Azure Stack HCI.
Get-AksHciVmSize List supported VM sizes.
Initialize-AksHciNode Run checks on every physical node to see if all requirements are satisfied to install Azure Kubernetes Service on Azure Stack HCI.
Install-AksHci Install the Azure Kubernetes Service on Azure Stack HCI agents/services and host.
Install-AksHciAdAuth Install Active Directory authentication.
Install-AksHciCsiNfs Installs the CSI NFS plug-in to a cluster.
Install-AksHciCsiSmb Installs the CSI SMB plug-in to a cluster.
Install-AksHciGmsaWebhook Installs gMSA webhook add-on to the cluster.
Install-AksHciMonitoring Installs Prometheus for monitoring in the Azure Kubernetes Service on Azure Stack HCI deployment.
New-AksHciCluster Create a new managed Kubernetes cluster.
New-AksHciClusterNetwork Create an object for a new virtual network.
New-AksHciNetworkSetting Create an object for a new virtual network.
New-AksHciNodePool Create a new node pool to an existing cluster.
New-AksHciProxySetting Create an object defining proxy server settings to pass into Set-AksHciConfig.
New-AksHciStorageContainer Creates a new storage container.
Remove-AksHciCluster Delete a managed Kubernetes cluster.
Remove-AksHciGmsaCredentialSpec Deletes a credentials spec for gMSA deployments on a cluster.
Remove-AksHciClusterNetwork Remove a cluster network object.
Remove-AksHciCluster Delete a managed Kubernetes cluster.
Remove-AksHciGmsaCredentialSpec Deletes a credentials spec for gMSA deployments on a cluster.
Remove-AksHciNode Remove a physical node from your deployment.
Repair-AksHciClusterCerts Troubleshoots and fixes errors related to expired certificated for Kubernetes built-in components.
Remove-AksHciNodePool Delete a node pool from a cluster.
Repair-AksHciCerts Troubleshoots and fixes errors related to expired certificates for the AKS on Azure Stack HCI host.
Restart-AksHci Restart Azure Kubernetes Service on Azure Stack HCI and remove all deployed Kubernetes clusters.
Set-AksHciCluster Scale the number of control plane nodes or worker nodes in a cluster.
Set-AksHciConfig Set or update the configurations settings for the Azure Kubernetes Service host.
Set-AksHciNodePool Scale a node pool within a Kubernetes cluster.
Set-AksHciRegistration Register Azure Kubernetes Service on Azure Stack HCI with Azure.
Sync-AksHciBilling Manually trigger a billing records sync.
Uninstall-AksHci Remove Azure Kubernetes Service on Azure Stack HCI.
Uninstall-AksHciAdAuth Remove Active Directory authentication.
Uninstall-AksHciCsiNfs Uninstalls CSI NFS Plugin in a cluster.
Uninstall-AksHciCsiSmb Uninstalls the CSI SMB plug-in in a cluster.
Uninstall-AksHciGmsaWebhook Uninstalls the gMSA webhook add-on to the cluster.
Uninstall-AksHciMonitoring Removes Prometheus for monitoring from the Azure Kubernetes Service on Azure Stack HCI deployment.
Update-AksHci Update the Azure Kubernetes Service host to the latest Kubernetes version.
Update-AksHciCluster Update a managed Kubernetes cluster to a newer Kubernetes or OS version.

Next steps

For more information, about the AKS on the Azure Stack HCI.