Skip to content

Commit 454c855

Browse files
Update article with corrections
1 parent bfd0164 commit 454c855

9 files changed

+39
-39
lines changed

articles/operator-nexus/howto-gather-vm-console-data.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,51 @@ ms.topic: how-to
88
ms.date: 11/26/2024
99
---
1010

11-
# Gathering Important Virtual Machine (VM) Console Data
11+
# Gather important Virtual Machine (VM) console data
1212

1313
The article provides generic guidance on how to collect data necessary for diagnosing VM console-related issues.
1414

1515
## Prerequisites to complete these procedures
1616

1717
In order to `ssh` to a virtual machine, you must have:
1818

19-
1. Created a `Private endpoint` connecting to the Cluster Manager's `Private link service`
20-
1. Virtual machine instance with a given name
21-
1. Created the corresponding Console with same name used for the virtual machine
19+
- Created a `Private endpoint` connecting to the Cluster Manager's `Private link service`
20+
- Virtual machine instance with a given name
21+
- Created the corresponding Console with same name used for the virtual machine
2222

23-
## Data Collection
23+
## Data collection
2424

2525
### Data needed by the VM Console service team for troubleshooting
2626

2727
If there's a problem that needs to further investigation by the VM Console service team, collect the following information to help them get started:
2828

29-
1. A detailed description of the problem and its affect to the customer.
30-
1. Screenshots. The Azure portal is obviously a visual component. Try to get as much visual data as possible to describe the problem happening. Screenshots are often the best way to show the problem or how to reproduce the problem.
31-
1. [Private Endpoint IP](#determining-the-private-endpoint-ip-address)
32-
1. [Private Endpoint connectivity](#determining-the-private-endpoint-connectivity)
33-
1. [Collecting Console Data](#collecting-the-console-data)
29+
- A detailed description of the problem and its effect to the customer.
30+
- Screenshots. The Azure portal is obviously a visual component. Try to get as much visual data as possible to describe the problem happening. Screenshots are often the best way to show the problem or how to reproduce the problem.
31+
- [Private Endpoint IP](#determining-the-private-endpoint-ip-address)
32+
- [Private Endpoint connectivity](#determining-the-private-endpoint-connectivity)
33+
- [Collecting Console Data](#collecting-the-console-data)
3434

35-
### Determining the private endpoint connectivity
35+
### Determine the private endpoint connectivity
3636

3737
1. Navigate to the Azure portal where customer's work environment is located.
38-
1. Select the Private endpoint resource used for `ssh` to the virtual machine
39-
![Private endpoint resource](./media/vm-console-ple-ip-1.png)
40-
1. In the Private endpoint screen, select the `Private link resource`
41-
![Private endpoint connectivity](./media/vm-console-ple-connectivity-1.png)
42-
1. Capture screenshot of `Private link resource` screen. Example of screenshot provided.
43-
![Private endpoint connectivity](./media/vm-console-ple-connectivity-2.png)
44-
1. Confirm with the customer that `Private endpoint` is referencing the correct `Private Link Service`, as it's possible that customer might be using the wrong PLE when trying to `ssh` to a virtual machine.
38+
2. Select the Private endpoint resource used for `ssh` to the virtual machine
39+
:::image type="content" source="media/vm-console-ple-ip-1.png" alt-text="Screenshot that shows the Private endpoint in its Resource Group.":::
40+
3. In the Private endpoint screen, select the `Private link resource`
41+
:::image type="content" source="media/vm-console-ple-connectivity-1.png" alt-text="Screenshot that shows the link to the Private link resource.":::
42+
4. Capture screenshot of `Private link resource` screen. Example of screenshot provided.
43+
:::image type="content" source="media/vm-console-ple-connectivity-2.png" alt-text="Screenshot that shows the details of the Private link resource.":::
44+
5. Confirm with the customer that `Private endpoint` is referencing the correct `Private Link Service`, as it's possible that customer might be using the wrong PLE when trying to `ssh` to a virtual machine.
4545

46-
### Determining the private endpoint IP address
46+
### Determine the private endpoint IP address
4747

4848
1. Navigate to the Azure portal where customer's work environment is located.
49-
1. Select the Private endpoint resource used for `ssh` to the virtual machine
50-
![Private endpoint resource](./media/vm-console-ple-ip-1.png)
51-
1. In the Private endpoint screen, select the `Network interface`
52-
![Private endpoint network interface](./media/vm-console-ple-ip-2.png)
53-
1. In that screen you'll find the `Private IPv4 address`, for example, `10.1.0.5`
54-
![Private endpoint IP address](./media/vm-console-ple-ip-3.png)
55-
1. Confirm with customer that whit IP address was in the `ssh` command, for example, `ssh -p 2222 <virtual machine access id>@10.1.0.5`
49+
2. Select the Private endpoint resource used for `ssh` to the virtual machine
50+
:::image type="content" source="media/vm-console-ple-connectivity-1.png" alt-text="Screenshot that shows the link to the Private link resource.":::
51+
3. In the Private endpoint screen, select the `Network interface`
52+
:::image type="content" source="media/vm-console-ple-ip-2.png" alt-text="Screenshot that shows the details of the Private link resource.":::
53+
4. In that screen, you find the `Private IPv4 address`, for example, `10.1.0.5`
54+
:::image type="content" source="media/vm-console-ple-ip-3.png" alt-text="Screenshot that shows the details of the Private IPV4 address.":::
55+
5. Confirm with customer that whit IP address was in the `ssh` command, for example, `ssh -p 2222 <virtual machine access id>@10.1.0.5`
5656

5757
Another way to retrieve the Private endpoint IP addresses is using Azure CLI, as shown here.
5858

@@ -68,21 +68,21 @@ done
6868

6969
In case the script option is used, ask the customer which private endpoint ip address was used.
7070

71-
### Collecting the Console data
71+
### Collect the Console data
7272

7373
1. Navigate to the Azure portal where the cluster manager is located.
74-
1. Select on `Extended location` to view its extended locations.
75-
![Cluster manager extended locations](./media/vm-console-resource-1.png)
76-
1. Select the Console resource in question.
77-
![Console to troubleshoot](./media/vm-console-resource-2.png)
78-
1. Collect the data for the console resource to be investigated.
79-
1. Console `Enabled`
80-
1. Console `Expiration`
81-
1. Console `Ssh public key`
82-
1. Console `Virtual machine access ID
83-
![Cluster manager extended locations](./media/vm-console-resource-3.png)
84-
85-
If the access to Azure portal isn't available, you may also to retrieve the Console data with `az networkcloud virtualmachine console show` command.
74+
2. Select on `Extended location` to view its extended locations.
75+
:::image type="content" source="media/vm-console-resource-1.png" alt-text="Screenshot that shows the Extended location of the cluster manager.":::
76+
3. Select the Console resource in question.
77+
:::image type="content" source="media/vm-console-resource-2.png" alt-text="Screenshot that shows the link to console resource.":::
78+
4. Collect the data for the console resource to be investigated.
79+
- Console `Enabled`
80+
- Console `Expiration`
81+
- Console `Ssh public key`
82+
- Console `Virtual machine access ID`
83+
:::image type="content" source="media/vm-console-resource-3.png" alt-text="Screenshot that shows the console resource.":::
84+
85+
If the access to Azure portal isn't available, you're also to retrieve the Console data with `az networkcloud virtualmachine console show` command.
8686

8787
```bash
8888
az networkcloud virtualmachine console show \
3.79 KB
Loading
-975 Bytes
Loading
-15.2 KB
Loading
4.26 KB
Loading
21.5 KB
Loading
8.64 KB
Loading
23.8 KB
Loading
-32.4 KB
Loading

0 commit comments

Comments
 (0)