Skip to content

Commit f3cfd9c

Browse files
authored
Update ssh-arc-overview.md
1 parent 69cbc02 commit f3cfd9c

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

articles/azure-arc/servers/ssh-arc-overview.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,41 @@ SSH access to Arc-enabled servers is currently supported in the following region
4242
- Ubuntu Server: Ubuntu Server 16.04 to Ubuntu Server 20.04
4343

4444
## Getting started
45+
46+
### Install local command line tool
47+
This functionality is currently packaged in an Azure CLI extension and an Azure PowerShell module.
48+
#### [Install Azure CLI extension](#tab/azure-cli)
49+
50+
```az extension add --name ssh```
51+
52+
> [!NOTE]
53+
> The Azure CLI extension version must be greater than 1.1.0.
54+
55+
#### [Install Azure PowerShell module](#tab/azure-powershell)
56+
57+
```Install-Module -Name AzPreview -Scope CurrentUser -Repository PSGallery -Force```
58+
59+
### Enable functionality on your Arc-enabled server
60+
In order to use the SSH connect feature, you must enable connections on the hybrid agent.
61+
62+
> [!NOTE]
63+
> The following actions must be completed in an elevated terminal session.
64+
65+
View your current incoming connections:
66+
67+
```azcmagent config list```
68+
69+
If you have existing ports, you will need to include them in the following command.
70+
71+
To add access to SSH connections, run the following:
72+
73+
```azcmagent config set incomingconnections.ports 22<,other open ports,...>```
74+
75+
If you are using a non-default port for your SSH connection, replace port 22 with your desired port in the previous command.
76+
77+
> [!NOTE]
78+
> The following steps will not need to be run for most users.
79+
4580
### Register the HybridConnectivity resource provider
4681
> [!NOTE]
4782
> This is a one-time operation that needs to be performed on each subscription.
@@ -56,19 +91,6 @@ If the RP has not been registered, run the following:
5691

5792
This operation can take 2-5 minutes to complete. Before moving on, check that the RP has been registered.
5893

59-
### Install az CLI extension
60-
This functionality is currently package in an az CLI extension.
61-
In order to install this extension, run:
62-
63-
```az extension add --name ssh```
64-
65-
If you already have the extension installed, it can be updated by running:
66-
67-
```az extension update --name ssh```
68-
69-
> [!NOTE]
70-
> The Azure CLI extension version must be greater than 1.1.0.
71-
7294
### Create default connectivity endpoint
7395
> [!NOTE]
7496
> The following actions must be completed for each Arc-enabled server.
@@ -86,24 +108,5 @@ Validate endpoint creation:
86108
az rest --method get --uri https://management.azure.com/subscriptions/<subscription>/resourceGroups/<resourcegroup>/providers/Microsoft.HybridCompute/machines/<arc enabled server name>/providers/Microsoft.HybridConnectivity/endpoints/default?api-version=2021-10-06-preview
87109
```
88110

89-
### Enable functionality on your Arc-enabled server
90-
In order to use the SSH connect feature, you must enable connections on the hybrid agent.
91-
92-
> [!NOTE]
93-
> The following actions must be completed in an elevated terminal session.
94-
95-
View your current incoming connections:
96-
97-
```azcmagent config list```
98-
99-
If you have existing ports, you will need to include them in the following command.
100-
101-
To add access to SSH connections, run the following:
102-
103-
```azcmagent config set incomingconnections.ports 22<,other open ports,...>```
104-
105-
> [!NOTE]
106-
> If you are using a non-default port for your SSH connection, replace port 22 with your desired port in the previous command.
107-
108111
## Examples
109-
To view examples of using the ```az ssh arc``` command, view the az CLI documentation page for [az ssh](/cli/azure/ssh).
112+
To view examples, view the Az CLI documentation page for [az ssh](/cli/azure/ssh) or the Azure PowerShell documentation page for [Az.Ssh](/powershell/module/az.ssh).

0 commit comments

Comments
 (0)