AKS Edge Essentials PowerShell module

PowerShell commands

Add-AksEdgeNode

Adds a new AksEdge node to the cluster.

Connect-AksEdgeArc

Connects the AKS Edge Essentials cluster running on this machine to Azure Arc for Kubernetes.

Copy-AksEdgeNodeFile

Copies a file to or from a node.

Disconnect-AksEdgeArc

Disconnects the AKS Edge Essentials cluster running on this machine from Azure Arc for Kubernetes.

Get-AksEdgeDeploymentInfo

Gets AKS Edge Essentials deployment information.

Get-AksEdgeEventLog

Collects event logs from the deployment.

Get-AksEdgeKubeConfig

Pulls the KubeConfig file from the specified node.

Get-AksEdgeLogs

Collects all the logs from the deployment.

Get-AksEdgeManagedServiceToken

Gets the AKS Edge Essentials managed service token, for instance for use for Azure ARC for Kubernetes connected cluster.

Get-AksEdgeNodeAddr

Gets the VM's IP and MAC addresses.

Get-AksEdgeNodeConnectivityMode

Gets the connectivity mode of the AKS Edge Essentials Linux node.

Get-AksEdgeNodeName

Gets the VM's hostname.

Get-AksEdgeUpgrade

Get whether AKS Edge Essentials is allowed to upgrade the Kubernetes version on update.

Invoke-AksEdgeNodeCommand

Executes an SSH command on the specified node.

Install-AksEdgeHostFeatures

Installs missing required OS features.

New-AksEdgeConfig

Creates the configuration file needed for a new AKS Edge Essentials deployment on this machine.

New-AksEdgeDeployment

Creates a new AKS Edge Essentials deployment on this machine.

New-AksEdgeScaleConfig

Creates the configuration file needed to scale the deployment to other machines.

Remove-AksEdgeDeployment

Removes the deployment from an existing cluster.

Remove-AksEdgeNode

Removes a local node from an existing cluster.

Set-AksEdgeBillingPodState

Allows AIDE front end to set Billing pod state after joining Arc through Azure CLI.

Set-AksEdgeNodeConnectivityMode

Sets AKS Edge Essentials node connectivity mode.

Set-AksEdgeNodeToDrain

Safely drains a node before your delete the node.

Set-AksEdgeUpgrade

Sets whether AKS Edge Essentials is allowed to upgrade the Kubernetes version on update.

Start-AksEdgeNode

Starts the node VM if it's currently stopped.

Start-AksEdgeUpdate

Starts the update process for updating AKS Edge Essentials.

Start-AksEdgeControlPlaneUpdate

Updates the control plane nodes on this machine as a part of the update process.

Start-AksEdgeWorkerNodeUpdate

Updates any worker nodes on this machine as part of the update process.

Stop-AksEdgeNode

Stops the node VM if it's currently started.

Test-AksEdgeArcConnection

Checks whether the cluster is Azure Arc connected.

Test-AksEdgeDeployment

Checks whether the deployment was created.

Test-AksEdgeNetworkParameters

Validates AKS Edge Essentials network parameters, useful as a pre-deployment check as well before scaling to multiple machines.

Test-AksEdgeNode

Checks whether the VM was created.