Network Watcher Agent virtual machine extension for Linux

Overview

Azure Network Watcher is a network performance monitoring, diagnostic, and analytics service that allows monitoring for Azure networks. The Network Watcher Agent virtual machine (VM) extension is a requirement for some of the Network Watcher features on Azure VMs, such as capturing network traffic on demand, and other advanced functionality.

This article details the supported platforms and deployment options for the Network Watcher Agent VM extension for Linux. Installation of the agent does not disrupt, or require a reboot, of the VM. You can deploy the extension into virtual machines that you deploy. If the virtual machine is deployed by an Azure service, check the documentation for the service to determine whether or not it permits installing extensions in the virtual machine.

Prerequisites

Operating system

The Network Watcher Agent extension can be configured for the following Linux distributions:

Distribution Version
Ubuntu 12+
Debian 7 and 8
Red Hat 6 and 7
Oracle Linux 6.8+ and 7
SUSE Linux Enterprise Server 11 and 12
OpenSUSE Leap 42.3+
CentOS 6.5+ and 7
CoreOS 899.17.0+

Internet connectivity

Some of the Network Watcher Agent functionality requires that a VM is connected to the Internet. Without the ability to establish outgoing connections, some of the Network Watcher Agent features may malfunction, or become unavailable. For more information about Network Watcher functionality that requires the agent, see theNetwork Watcher documentation.

Extension schema

The following JSON shows the schema for the Network Watcher Agent extension. The extension doesn't require, or support, any user-supplied settings. The extension relies on its default configuration.

{
    "type": "extensions",
    "name": "Microsoft.Azure.NetworkWatcher",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.Azure.NetworkWatcher",
        "type": "NetworkWatcherAgentLinux",
        "typeHandlerVersion": "1.4",
        "autoUpgradeMinorVersion": true
    }
}

Property values

Name Value / Example
apiVersion 2015-06-15
publisher Microsoft.Azure.NetworkWatcher
type NetworkWatcherAgentLinux
typeHandlerVersion 1.4

Template deployment

You can deploy Azure VM extensions with an Azure Resource Manager template. To deploy the Network Watcher Agent extension, use the previous json schema in your template.

Azure CLI 1.0 deployment

The following example deploys the Network Watcher Agent VM extension to an existing VM deployed through the classic deployment model:

azure config mode asm
azure vm extension set myVM1 NetworkWatcherAgentLinux Microsoft.Azure.NetworkWatcher 1.4

Azure CLI 2.0 deployment

The following example deploys the Network Watcher Agent VM extension to an existing VM deployed through Resource Manager:

az vm extension set --resource-group myResourceGroup1 --vm-name myVM1 --name NetworkWatcherAgentLinux --publisher Microsoft.Azure.NetworkWatcher --version 1.4

Troubleshooting and support

Troubleshooting

You can retrieve data about the state of extension deployments using either the Azure portal or Azure CLI.

The following example shows the deployment state of extensions for a VM deployed through the classic deployment model, using the Azure CLI 1.0:

azure config mode asm
azure vm extension get myVM1

Extension execution output is logged to files found in the following directory:

/var/log/azure/Microsoft.Azure.NetworkWatcher.NetworkWatcherAgentLinux/

The following example shows the deployment state of the NetworkWatcherAgentLinux extension for a VM deployed through Resource Manager, using the Azure CLI 2.0:

az vm extension show --name NetworkWatcherAgentLinux --resource-group myResourceGroup1 --vm-name myVM1

Support

If you need more help at any point in this article, you can refer to the Network Watcher documentation, or contact the Azure experts on the MSDN Azure and Stack Overflow forums. Alternatively, you can file an Azure support incident. Go to the Azure support site and select Get support. For information about using Azure Support, see the Microsoft Azure support FAQ.