Skip to content

Commit 3806466

Browse files
committed
add tabs for portal, powershell, cli, and arm
1 parent f4232f9 commit 3806466

File tree

1 file changed

+57
-40
lines changed

1 file changed

+57
-40
lines changed

articles/virtual-machines/extensions/network-watcher-linux.md

Lines changed: 57 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,77 @@
11
---
2-
title: Network Watcher Agent VM extension - Linux
3-
description: Deploy the Network Watcher Agent virtual machine extension on Linux virtual machines.
2+
title: Manage Network Watcher Agent VM extension - Linux
3+
description: Learn about the Network Watcher Agent virtual machine extension for Linux virtual machines and how to install and uninstall it.
44
author: halkazwini
55
ms.author: halkazwini
66
ms.service: virtual-machines
77
ms.subservice: extensions
8-
ms.topic: concept-article
8+
ms.topic: how-to
99
ms.collection: linux
10-
ms.date: 03/26/2024
11-
ms.custom: devx-track-azurecli, linux-related-content
10+
ms.date: 03/31/2024
11+
ms.custom: devx-track-azurepowershell, devx-track-azurecli, devx-track-arm-template, linux-related-content
1212
---
1313

14-
# Network Watcher Agent virtual machine extension for Linux
14+
# Manage Network Watcher Agent virtual machine extension for Linux
1515

1616
> [!CAUTION]
1717
> This article references CentOS, a Linux distribution that is nearing End Of Life (EOL) status. Please consider your use and planning accordingly. For more information, see the [CentOS End Of Life guidance](~/articles/virtual-machines/workloads/centos/centos-end-of-life.md).
1818
1919
[Azure Network Watcher](../../network-watcher/network-watcher-monitoring-overview.md) is a network performance monitoring, diagnostic, and analytics service that allows monitoring for Azure networks. The Network Watcher Agent virtual machine extension is a requirement for some of the Network Watcher features on Azure virtual machines (VMs), such as capturing network traffic on demand, and other advanced functionality.
2020

21-
This article details the supported platforms and deployment options for the Network Watcher Agent VM extension for Linux. Installation of the agent doesn't disrupt, or require a reboot of the virtual machine. You can install the extension on 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.
21+
In this article, you learn about the supported platforms and deployment options for the Network Watcher Agent VM extension for Linux. Installation of the agent doesn't disrupt, or require a reboot of the virtual machine. You can install the extension on 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.
2222

2323
> [!NOTE]
2424
> Network Watcher Agent extension is not supported on AKS clusters.
2525
2626
## Prerequisites
2727

28-
### Operating system
28+
# [**Portal**](#tab/portal)
2929

30-
The Network Watcher Agent extension can be configured for the following Linux distributions:
30+
- An Azure Linux virtual machine (VM). For more information, see [Supported operating systems](#supported-operating-systems).
31+
32+
- Internet connectivity: some of the Network Watcher Agent functionality requires that the virtual machine is connected to the internet. For example, without the ability to establish outgoing connections, the Network Watcher Agent can't upload packet captures to your storage account. For more information, see [Packet capture overview](../../network-watcher/packet-capture-overview.md).
33+
34+
# [**PowerShell**](#tab/powershell)
35+
36+
- An Azure Linux virtual machine (VM). For more information, see [Supported operating systems](#supported-operating-systems).
37+
38+
- Internet connectivity: some of the Network Watcher Agent functionality requires that the virtual machine is connected to the internet. For example, without the ability to establish outgoing connections, the Network Watcher Agent can't upload packet captures to your storage account. For more information, see [Packet capture overview](../../network-watcher/packet-capture-overview.md).
39+
40+
- Azure Cloud Shell or Azure PowerShell.
41+
42+
The steps in this article run the Azure PowerShell cmdlets interactively in [Azure Cloud Shell](/azure/cloud-shell/overview). To run the commands in the Cloud Shell, select **Open Cloud Shell** at the upper-right corner of a code block. Select **Copy** to copy the code and then paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.
43+
44+
You can also [install Azure PowerShell locally](/powershell/azure/install-azure-powershell) to run the cmdlets. This article requires the Azure PowerShell `Az` module. To find the installed version, run `Get-Module -ListAvailable Az`. If you run PowerShell locally, sign in to Azure using the [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet.
45+
46+
# [**Azure CLI**](#tab/cli)
47+
48+
- An Azure Linux virtual machine (VM). For more information, see [Supported operating systems](#supported-operating-systems).
49+
50+
- Internet connectivity: some of the Network Watcher Agent functionality requires that the virtual machine is connected to the internet. For example, without the ability to establish outgoing connections, the Network Watcher Agent can't upload packet captures to your storage account. For more information, see [Packet capture overview](../../network-watcher/packet-capture-overview.md).
51+
52+
- Azure Cloud Shell or Azure CLI.
53+
54+
The steps in this article run the Azure CLI commands interactively in [Azure Cloud Shell](/azure/cloud-shell/overview). To run the commands in the Cloud Shell, select **Open Cloud Shell** at the upper-right corner of a code block. Select **Copy** to copy the code, and paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.
55+
56+
You can also [install Azure CLI locally](/cli/azure/install-azure-cli) to run the commands. If you run Azure CLI locally, sign in to Azure using the [az login](/cli/azure/reference-index#az-login) command.
57+
58+
# [**Resource Manager**](#tab/arm)
59+
60+
- An Azure Linux virtual machine (VM). For more information, see [Supported operating systems](#supported-operating-systems).
61+
62+
- Internet connectivity: some of the Network Watcher Agent functionality requires that the virtual machine is connected to the internet. For example, without the ability to establish outgoing connections, the Network Watcher Agent can't upload packet captures to your storage account. For more information, see [Packet capture overview](../../network-watcher/packet-capture-overview.md).
63+
64+
- Azure PowerShell or Azure CLI installed locally to deploy the template.
65+
66+
- You can [install Azure PowerShell locally](/powershell/azure/install-azure-powershell) to run the cmdlets. Use [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet to sign in to Azure.
67+
68+
- You can [install Azure CLI locally](/cli/azure/install-azure-cli) to run the commands. Use [az login](/cli/azure/reference-index#az-login) command to sign in to Azure.
69+
70+
---
71+
72+
## Supported operating systems
73+
74+
Network Watcher Agent extension for Linux can be installed on the following Linux distributions:
3175

3276
| Distribution | Version |
3377
|---|---|
@@ -46,22 +90,18 @@ The Network Watcher Agent extension can be configured for the following Linux di
4690
> - Red Hat Enterprise Linux 6.X and Oracle Linux 6.x have reached their end-of-life (EOL). RHEL 6.10 has available [extended life cycle (ELS) support](https://www.redhat.com/en/resources/els-datasheet) through [June 30, 2024]( https://access.redhat.com/product-life-cycles/?product=Red%20Hat%20Enterprise%20Linux,OpenShift%20Container%20Platform%204).
4791
> - Oracle Linux version 6.10 has available [ELS support](https://www.oracle.com/a/ocom/docs/linux/oracle-linux-extended-support-ds.pdf) through [July 1, 2024](https://www.oracle.com/a/ocom/docs/elsp-lifetime-069338.pdf).
4892
49-
### Internet connectivity
50-
51-
Some of the Network Watcher Agent functionality requires that the virtual machine 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 the [Network Watcher documentation](../../network-watcher/index.yml).
52-
5393
## Extension schema
5494

5595
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.
5696

5797
```json
5898
{
59-
"type": "Microsoft.Compute/virtualMachines/extensions",
6099
"name": "[concat(parameters('vmName'), '/AzureNetworkWatcherExtension')]",
61-
"apiVersion": "[variables('apiVersion')]",
100+
"type": "Microsoft.Compute/virtualMachines/extensions",
101+
"apiVersion": "2023-03-01",
62102
"location": "[resourceGroup().location]",
63103
"dependsOn": [
64-
"[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
104+
"[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'))]"
65105
],
66106
"properties": {
67107
"autoUpgradeMinorVersion": true,
@@ -70,33 +110,12 @@ The following JSON shows the schema for the Network Watcher Agent extension. The
70110
"typeHandlerVersion": "1.4"
71111
}
72112
}
73-
74113
```
75114

76-
### Property values
77-
78-
| Name | Value / Example |
79-
| ---- | ---- |
80-
| apiVersion | 2023-03-01 |
81-
| publisher | Microsoft.Azure.NetworkWatcher |
82-
| type | NetworkWatcherAgentLinux |
83-
| typeHandlerVersion | 1.4 |
84-
85115
## Template deployment
86116

87117
You can deploy Azure VM extensions with an Azure Resource Manager template (ARM template) using the previous JSON [schema](#extension-schema).
88118

89-
## Azure classic CLI deployment
90-
91-
[!INCLUDE [classic-vm-deprecation](../../../includes/classic-vm-deprecation.md)]
92-
93-
The following example deploys the Network Watcher Agent VM extension to an existing VM deployed through the classic deployment model:
94-
95-
```console
96-
azure config mode asm
97-
azure vm extension set myVM1 NetworkWatcherAgentLinux Microsoft.Azure.NetworkWatcher 1.4
98-
```
99-
100119
## Azure CLI deployment
101120

102121
The following example deploys the Network Watcher Agent VM extension to an existing VM deployed through Resource Manager:
@@ -105,9 +124,7 @@ The following example deploys the Network Watcher Agent VM extension to an exist
105124
az vm extension set --resource-group myResourceGroup1 --vm-name myVM1 --name NetworkWatcherAgentLinux --publisher Microsoft.Azure.NetworkWatcher --version 1.4
106125
```
107126

108-
## Troubleshooting and support
109-
110-
### Troubleshooting
127+
## Troubleshooting
111128

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

0 commit comments

Comments
 (0)