You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: Connect hybrid machines to Azure from the Azure portal
3
-
description: In this article, you learn how to install the agent and connect machines to Azure using Azure Arc for servers (preview) from the Azure portal.
3
+
description: In this article, you learn how to install the agent and connect machines to Azure by using Azure Arc for servers (preview) from the Azure portal.
4
4
services: azure-arc
5
5
ms.service: azure-arc
6
6
ms.subservice: azure-arc-servers
@@ -13,49 +13,51 @@ ms.topic: quickstart
13
13
14
14
# Connect hybrid machines to Azure from the Azure portal
15
15
16
-
You can enable Azure Arc for servers (preview) for one or a small number of Windows or Linux machines in your environment by performing a set of steps manually, or using an automated method by running a template script that we provide. This script automates the download and installation of both agents.
16
+
You can enable Azure Arc for servers (preview) for one or a small number of Windows or Linux machines in your environment by performing a set of steps manually. Or you can use an automated method by running a template script that we provide. This script automates the download and installation of both agents.
17
17
18
-
This installation method requires that you have administrative rights on the machine to install and configure the agent. On Linux, using the root account and on Windows, you are member of the Local Administrators group.
18
+
This method requires that you have administrator permissions on the machine to install and configure the agent. On Linux, by using the root account, and on Windows, you are member of the Local Administrators group.
19
19
20
20
Before you get started, be sure to review the [prerequisites](overview.md#prerequisites) and verify that your subscription and resources meet the requirements.
21
21
22
22
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
23
23
24
-
## Generate install script from the Azure portal
24
+
## Generate the installation script from the Azure portal
25
25
26
-
The script to automate the download, installation, and establishing the connection with Azure Arc is available from the Azure portal. The following steps describe how to complete this process.
26
+
The script to automate the download and installation, and to establish the connection with Azure Arc, is available from the Azure portal. To complete the process, do the following:
27
27
28
-
1. From your browser, launch [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
28
+
1. From your browser, go to the [Azure portal](https://aka.ms/hybridmachineportal).
29
29
30
-
2. On the **Machines - Azure Arc** page, either select **+Add** in the upper left-hand corner, or select the **Create machine - Azure Arc** option from the bottom of the middle pane.
30
+
1. On the **Machines - Azure Arc** page, select either **Add**, at the upper left, or the **Create machine - Azure Arc** option at the bottom of the middle pane.
31
31
32
-
3. On the **Select a method** page, select from the **Add machines using interactive script** tile **Generate script**.
32
+
1. On the **Select a method** page, select the **Add machines using interactive script** tile, and then select**Generate script**.
33
33
34
-
4. On the **Generate script** page, select the subscription and resource group where you want the machine to be managed within Azure. Select an Azure location where machine metadata will be stored.
34
+
1. On the **Generate script** page, select the subscription and resource group where you want the machine to be managed within Azure. Select an Azure location where the machine metadata will be stored.
35
35
36
36
>[!NOTE]
37
-
>Azure Arc for servers (preview), only supports the following regions:
37
+
>Azure Arc for servers (preview)supports only the following regions:
38
38
>- WestUS2
39
39
>- WestEurope
40
40
>- WestAsia
41
41
>
42
42
43
-
5. On the **Generate script** page, under the **Operating system** drop-down list, select the appropriate operating system the script will be running on.
43
+
1. On the **Generate script** page, in the **Operating system** drop-down list, select the operating system that the script will be running on.
44
44
45
-
6. If the machine is communicating through a proxy server in order to connect to the Internet, select the option **Next: Proxy Server>**. On the **Proxy server** tab, specify the proxy server IP address or name and port number that the machine will use to communicate with the proxy server. Enter the value following the format `http://<proxyURL>:<proxyport>`. Once completed, select **Review + generate**. Otherwise, select **Review + generate** to complete the steps.
45
+
1. If the machine is communicating through a proxy server to connect to the internet, select **Next: Proxy Server**.
46
+
1. On the **Proxy server** tab, specify the proxy server IP address or the name and port number that the machine will use to communicate with the proxy server. Enter the value in the format `http://<proxyURL>:<proxyport>`.
47
+
1. Select **Review + generate**.
46
48
47
-
7. On the **Review + generate** tab, review the summary information, and then select **Download**. Otherwise if you need to make changes, you can select **Previous**.
49
+
1. On the **Review + generate** tab, review the summary information, and then select **Download**. If you still need to make changes, select **Previous**.
48
50
49
51
## Install and validate the agent on Windows
50
52
51
53
### Install manually
54
+
You can install the Connected Machine agent manually by running the Windows Installer package *AzureConnectedMachineAgent.msi*.
52
55
53
-
You can install the Connected Machine agent manually by running the Windows Installer installation package `AzureConnectedMachineAgent.msi` after downloading it and copying it to a folder on the target server, or from a shared network folder. If you run the Installer package without any options, it starts a setup wizard that you can follow to install the agent interactively.
56
+
> [!NOTE]
57
+
> * To install or uninstall the agent, you must have *Administrator* permissions.
58
+
> * You must first download and copy the Installer package to a folder on the target server, or from a shared network folder. If you run the Installer package without any options, it starts a setup wizard that you can follow to install the agent interactively.
54
59
55
-
>[!NOTE]
56
-
>*Administrator* privileges are required to install or uninstall the agent.
57
-
58
-
If the machine needs to communicate through a proxy server to the service, after you install the agent you need to run a command described in a section below, to set the proxy server system environment variable `https_proxy`.
60
+
If the machine needs to communicate through a proxy server to the service, after you install the agent you need to run a command that's described later in the article. This sets the proxy server system environment variable `https_proxy`.
59
61
60
62
The following table highlights the parameters that are supported by setup for the agent from the command line.
61
63
@@ -68,23 +70,23 @@ For example, to run the installation program with the `/?` parameter, enter `msi
68
70
69
71
Files for the Connected Machine agent are installed in *C:\Program Files\AzureConnectedMachineAgent* by default. If the agent fails to start after setup is finished, check the logs for detailed error information. The log directory is *%Programfiles%\AzureConnectedMachineAgentAgent\logs*.
70
72
71
-
### Install using scripted method
73
+
### Install with the scripted method
72
74
73
-
1. Log onto the server.
75
+
1. Log in to the server.
74
76
75
-
2. Open an elevated PowerShell command prompt.
77
+
1. Open an elevated PowerShell command prompt.
76
78
77
-
3. Change to the folder or share you copied the script to and execute it on the server by running the command `./OnboardingScript.ps1`.
79
+
1. Change to the folder or share that you copied the script to, and execute it on the server by running the `./OnboardingScript.ps1` script.
78
80
79
-
### Configure agent proxy setting
81
+
### Configure the agent proxy setting
80
82
81
-
Run the following command to set the proxy server environment variable.
83
+
To set the proxy server environment variable, run the following command:
82
84
83
85
```powershell
84
-
# If a proxy server is needed, execute these commands with proxy URL and port
86
+
# If a proxy server is needed, execute these commands with the proxy URL and port.
# The agent service needs to be restarted after the proxy environment variable is set in order for the changes to take effect.
89
+
# For the changes to take effect, the agent service needs to be restarted after the proxy environment variable is set.
88
90
Restart-Service -Name himds
89
91
```
90
92
@@ -100,18 +102,19 @@ After installing the agent, you need to configure the agent to communicate with
100
102
101
103
## Install and validate the agent on Linux
102
104
103
-
The Connected Machine agent for Linux is provided in the preferred package format for the distribution (.RPM or .DEB) hosted on Microsoft's[package repository](https://packages.microsoft.com/). A shell script bundle `Install_linux_azcmagent.sh` located at [https://aka.ms/azcmagent](https://aka.ms/azcmagent) performs the following actions:
105
+
The Connected Machine agent for Linux is provided in the preferred package format for the distribution (.RPM or .DEB) that's hosted in the Microsoft [package repository](https://packages.microsoft.com/). The [shell script bundle `Install_linux_azcmagent.sh`](https://aka.ms/azcmagent) performs the following actions:
104
106
105
107
- Configures the host machine to download the agent package from packages.microsoft.com.
106
108
- Installs the Hybrid Resource Provider package.
107
-
- Optionally, configure the agent with your proxy information by including the `--proxy "{proxy-url}:{proxy-port}"` parameter.
108
109
109
-
The script also contains logic to identify supported and unsupported distributions, as well as verifying required permissions to perform the installation.
110
+
Optionally, you can configure the agent with your proxy information by including the `--proxy "{proxy-url}:{proxy-port}"` parameter.
110
111
111
-
The example below downloads the agent and installs it, without performing any of the conditional checks.
112
+
The script also contains logic to identify the supported and unsupported distributions, and it verifies the permissions that are required to perform the installation.
113
+
114
+
The following example downloads the agent and installs it:
To download and install the agent, including the `--proxy` parameter for configuring the agent to communicate through your proxy server, run the following commands:
After performing the steps to install the agent and configure it to connect to Azure Arc for servers (preview), go to the Azure portal to verify that the server has been successfully connected. You can view your machines in the Azure portal by visiting [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
142
+
After you install the agent and configure it to connect to Azure Arc for servers (preview), go to the Azure portal to verify that the server has been successfully connected. View your machines in the [Azure portal](https://aka.ms/hybridmachineportal).

142
145
143
146
## Clean up
144
147
145
-
To disconnect a machine from Azure Arc for servers (preview), you need to perform the following steps.
146
-
147
-
1. Open Azure Arc for servers (preview) by visiting [https://aka.ms/hybridmachineportal](https://aka.ms/hybridmachineportal).
148
+
To disconnect a machine from Azure Arc for servers (preview), do the following:
148
149
149
-
2. Select the machine in the list, click the ellipse (`...`) and select **Delete**.
150
+
1. Open Azure Arc for servers (preview) by going to the [Azure portal](https://aka.ms/hybridmachineportal).
150
151
151
-
3. To uninstall the Windows agent from the machine, perform the following:
152
+
1. Select the machine in the list, select the ellipsis (**...**), and then select **Delete**.
152
153
153
-
1.Sign on to the computer with an account that has administrative rights.
154
+
1.To uninstall the Windows agent from the machine, do the following:
154
155
155
-
2. In **Control Panel**, select **Programs and Features**.
156
+
a. Sign in to the computer with an account that has administrator permissions.
157
+
b. In **Control Panel**, select **Programs and Features**.
158
+
c. In **Programs and Features**, select **Azure Connected Machine Agent**, select **Uninstall**, and then select **Yes**.
156
159
157
-
3. In **Programs and Features**, select **Azure Connected Machine Agent**, select **Uninstall**, and then select **Yes**.
158
-
159
-
>[!NOTE]
160
-
>The agent Setup Wizard can also be run by double-clicking **AzureConnectedMachineAgent.msi** installer package.
160
+
>[!NOTE]
161
+
> You can also run the agent setup wizard by double-clicking the **AzureConnectedMachineAgent.msi** installer package.
161
162
162
-
If you would like to script the uninstall, you can use the following example, which retrieves the product code and uninstalls the agent using the Msiexec.exe command line - `msiexec /x {Product Code}`. Open the Registry Editor and look under the registry key `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall` and find the product code GUID. You can then uninstall the agent using Msiexec.
163
+
If you want to script the uninstallation, you can use the following example, which retrieves the product code and uninstalls the agent by using the Msiexec.exe command line - `msiexec /x {Product Code}`. To do so:
164
+
165
+
a. Open the Registry Editor.
166
+
b. Under registry key `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall`, look for and copy the product code GUID.
167
+
c. You can then uninstall the agent by using Msiexec.
163
168
164
-
The example below demonstrates uninstalling the agent.
169
+
The following example demonstrates how to uninstall the agent:
0 commit comments