azcmagent extension

Local management of Azure Arc extensions installed on the machine. These commands can be run even when a machine is in a disconnected state.

The extension manager must be stopped before running any of these commands. Stopping the extension manager interrupts any in-progress extension installs, upgrades, and removals. To disable the extension manager, run Stop-Service ExtensionService on Windows or systemctl stop extd. When you're done managing extensions locally, start the extension manager again with Start-Service ExtensionService on Windows or systemctl start extd on Linux.

Commands

Command	Purpose
azcmagent extension list	Lists extensions installed on the machine
azcmagent extension remove	Uninstalls extensions on the machine

azcmagent extension list

Lists extensions installed on the machine.

Usage

azcmagent extension list [flags]

Examples

See which extensions are installed on your machine.

azcmagent extension list

Flags

Common flags available for all commands

--config

Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:

{
    "verbose": true
}

If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.

-h, --help

Get help for the current command, including its syntax and command line options.

-j, --json

Output the command result in the JSON format.

--log-stderr

Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.

--no-color

Disable color output for terminals that do not support ANSI colors.

-v, --verbose

Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.

azcmagent extension remove

Uninstalls extensions on the machine.

Usage

azcmagent extension remove [flags]

Examples

Remove the "AzureMonitorWindowsAgent" extension from the local machine.

azcmagent extension remove --name AzureMonitorWindowsAgent

Remove all extensions from the local machine.

azcmagent extension remove --all

Flags

--all, -a

Removes all extensions from the machine.

--name, -n

Removes the specified extension from the machine. Use azcmagent extension list to get the name of the extension.

Common flags available for all commands

--config

Takes in a path to a JSON or YAML file containing inputs to the command. The configuration file should contain a series of key-value pairs where the key matches an available command line option. For example, to pass in the --verbose flag, the configuration file would look like:

{
    "verbose": true
}

If a command line option is found in both the command invocation and a configuration file, the value specified on the command line will take precedence.

-h, --help

Get help for the current command, including its syntax and command line options.

-j, --json

Output the command result in the JSON format.

--log-stderr

Redirect error and verbose messages to the standard error (stderr) stream. By default, all output is sent to the standard output (stdout) stream.

--no-color

Disable color output for terminals that do not support ANSI colors.

-v, --verbose

Show more detailed logging information while the command executes. Useful for troubleshooting issues when running a command.