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
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/manage-agent.md
+74-2Lines changed: 74 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ ms.service: azure-arc
6
6
ms.subservice: azure-arc-servers
7
7
author: mgoedtel
8
8
ms.author: magoedte
9
-
ms.date: 04/01/2020
9
+
ms.date: 04/14/2020
10
10
ms.topic: conceptual
11
11
---
12
12
@@ -108,6 +108,78 @@ Actions of the [yum](https://access.redhat.com/articles/yum-cheat-sheet) command
108
108
109
109
Actions of the [zypper](https://en.opensuse.org/Portal:Zypper) command, such as installation and removal of packages, are logged in the `/var/log/zypper.log` log file.
110
110
111
+
## About the Azcmagent tool
112
+
113
+
The Azcmagent tool (Azcmagent.exe) is used to configure the Azure Arc for servers (preview) Connected Machine agent during installation, or modify the initial configuration of the agent after installation. Azcmagent.exe provides command-line parameters to customize the agent and view its status:
114
+
115
+
* **Connect** - To connect the machine to Azure Arc
116
+
117
+
* **Disconnect** - To disconnect the machine from Azure Arc
118
+
119
+
* **Reconnect** - To reconnect a disconnected machine to Azure Arc
120
+
121
+
* **Show** - View agent status and its configuration properties (Resource Group name, Subscription ID, version, etc.), which can help when troubleshooting an issue with the agent.
122
+
123
+
* **-h or --help** - Shows available command-line parameters
124
+
125
+
For example, to see detailed help for the **Reconnect** parameter, type `azcmagent reconnect -h`.
126
+
127
+
* **-v or --verbose** - Enable verbose logging
128
+
129
+
You can perform a **Connect**, **Disconnect**, and **Reconnect** manually while logged on interactively, or automate using the same service principal you used to onboard multiple agents or with a Microsoft identity platform [access token](../../active-directory/develop/access-tokens.md). If you did not use a service principal to register the machine with Azure Arc for servers (preview), see the following [article](onboard-service-principal.md#create-a-service-principal-for-onboarding-at-scale) to create a service principal.
130
+
131
+
### Connect
132
+
133
+
This parameter specifies a resource in Azure Resource Manager representing the machine is created in Azure. The resource is in the subscription and resource group specified, and data about the machine is stored in the Azure region specified by the `--location` setting. The default resource name is the hostname of this machine if not specified.
134
+
135
+
A certificate corresponding to the system-assigned identity of the machine is then downloaded and stored locally. Once this step is completed, the Azure Connected Machine Metadata Service and Guest Configuration Agent begin synchronizing with Azure Arc for servers (preview).
136
+
137
+
To connect using a service principal, run the following command:
This parameter specifies a resource in Azure Resource Manager representing the machine is deleted in Azure. It does not delete the agent from the machine, this must be done as a separate step. After the machine is disconnected, if you want to re-register it with Azure Arc for servers (preview), use `azcmagent connect` so a new resource is created for it in Azure.
152
+
153
+
To disconnect using a service principal, run the following command:
To disconnect with your elevated logged-on credentials (interactive), run the following command:
162
+
163
+
`azcmagent disconnect --tenant-id <tenantID>`
164
+
165
+
### Reconnect
166
+
167
+
This parameter reconnects the already registered or connected machine with Azure Arc for servers (preview). This may be necessary if the machine has been turned off, at least 45 days, for its certificate to expire. This parameter uses the authentication options provided to retrieve new credentials corresponding to the Azure Resource Manager resource representing this machine.
168
+
169
+
This command requires higher privileges than the [Azure Connected Machine Onboarding](overview.md#required-permissions) role.
170
+
171
+
To reconnect using a service principal, run the following command:
To reconnect with your elevated logged-on credentials (interactive), run the following command:
180
+
181
+
`azcmagent reconnect --tenant-id <tenantID>`
182
+
111
183
## Remove the agent
112
184
113
185
Perform one of the following methods to uninstall the Windows or Linux Connected Machine agent from the machine. Removing the agent does not unregister the machine with Arc for servers (preview), this is a separate process you perform when you no longer need to manage the machine in Azure.
@@ -179,7 +251,7 @@ To uninstall the Linux agent, the command to use depends on the Linux operating
179
251
180
252
## Unregister machine
181
253
182
-
If you are planning to stop managing the machine with supporting services in Azure, perform the following steps to unregister the machine with Arc for servers (preview). You can perform these step either before or after you have removed the Connected Machine agent from the machine.
254
+
If you are planning to stop managing the machine with supporting services in Azure, perform the following steps to unregister the machine with Arc for servers (preview). You can perform these steps either before or after you have removed the Connected Machine agent from the machine.
183
255
184
256
1. Open Azure Arc for servers (preview) by going to the [Azure portal](https://aka.ms/hybridmachineportal).
Copy file name to clipboardExpand all lines: articles/azure-arc/servers/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,7 @@ You can download the Azure Connected Machine agent package for Windows and L
138
138
>[!NOTE]
139
139
>During this preview, only one package has been released, which is suitable for Ubuntu 16.04 or 18.04.
140
140
141
-
The Azure Connected Machine agent for Windows and Linux can be upgraded to the latest release manually or automatically depending on your requirements. For more information, see [here](manage-agent.md)
141
+
The Azure Connected Machine agent for Windows and Linux can be upgraded to the latest release manually or automatically depending on your requirements. For more information, see [here](manage-agent.md).
0 commit comments