Invoke-AksEdgeNodeCommand

  • Article

Executes an SSH command on the VM.

Syntax

Invoke-AksEdgeNodeCommand [[-command] <String>] [-ignoreError] [[-NodeType] <String>]

Description

The Invoke-AksEdgeNodeCommand cmdlet executes a command inside the virtual machine and returns the output. This cmdlet only works for commands that return a finite output. It can't be used for commands that require user interaction or that runs indefinitely.

Examples

Invoke-AksEdgeNodeCommand -Command "sudo ps aux"

Parameters

-command

Command to be executed in the VM

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ignoreError

Optionally, if this flag is present, ignore errors from the command (don't throw).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NodeType

NodeType specifies Linux or Windows node to connect to. Default is Linux.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Linux
Accept pipeline input: False
Accept wildcard characters: False

Next steps

AksEdge PowerShell Reference