Skip to content

Commit 2bd9d6c

Browse files
authored
Merge pull request #50377 from asinn826/master
update common scenarios and add accessbility
2 parents b1f8831 + 3d08b09 commit 2bd9d6c

File tree

2 files changed

+37
-11
lines changed

2 files changed

+37
-11
lines changed

articles/virtual-machines/linux/serial-console.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For serial console documentation for Windows VMs, [click here](../windows/serial
3535
* Your virtual machine MUST have [boot diagnostics](boot-diagnostics.md) enabled - see screenshot below.
3636

3737
![](../media/virtual-machines-serial-console/virtual-machine-serial-console-diagnostics-settings.png)
38-
38+
3939
* The Azure account using the serial console must have [Contributor role](../../role-based-access-control/built-in-roles.md) for the VM and the [boot diagnostics](boot-diagnostics.md) storage account.
4040
* The virtual machine for which you are acessing serial console must also have a password-based account. You can create one with the [reset password](https://docs.microsoft.com/azure/virtual-machines/extensions/vmaccess#reset-password) functionality of the VM access extension - see the screenshot below.
4141

@@ -121,14 +121,14 @@ This means that the user who gets disconnected will not be logged out! The abili
121121
The serial console functionality can be deactivated for specific VMs by disabling that VM's boot diagnostics setting.
122122
123123
## Common scenarios for accessing serial console
124-
Scenario | Actions in serial console | OS Applicability
125-
:------------------|:-----------------------------------------|:------------------
126-
Broken FSTAB file | `Enter` key to continue and fix fstab file using a text editor. You may need to be in single user mode for this. See [how to fix fstab issues](https://support.microsoft.com/help/3206699/azure-linux-vm-cannot-start-because-of-fstab-errors) and [Using Serial Console to access GRUB and Single User Mode](serial-console-grub-single-user-mode.md) to get started. | Linux
127-
Incorrect firewall rules | Access serial console and fix iptables or Windows firewall rules. | Linux/Windows
128-
Filesystem corruption/check | Access serial console and recover filesystem. | Linux/Windows
129-
SSH/RDP configuration issues | Access serial console and change settings. | Linux/Windows
130-
Network lock down system| Access serial console via portal to manage system. | Linux/Windows
131-
Interacting with bootloader | Access GRUB/BCD via the serial console. Go to [Using Serial Console to access GRUB and Single User Mode](serial-console-grub-single-user-mode.md) to get started. | Linux/Windows
124+
Scenario | Actions in serial console
125+
:------------------|:-----------------------------------------
126+
Broken FSTAB file | `Enter` key to continue and fix fstab file using a text editor. You may need to be in single user mode for this. See [how to fix fstab issues](https://support.microsoft.com/help/3206699/azure-linux-vm-cannot-start-because-of-fstab-errors) and [Using Serial Console to access GRUB and Single User Mode](serial-console-grub-single-user-mode.md) to get started.
127+
Incorrect firewall rules | Access serial console and fix iptables.
128+
Filesystem corruption/check | Access serial console and recover filesystem.
129+
SSH/RDP configuration issues | Access serial console and change settings.
130+
Network lock down system| Access serial console via portal to manage system.
131+
Interacting with bootloader | Access GRUB via the serial console. Go to [Using Serial Console to access GRUB and Single User Mode](serial-console-grub-single-user-mode.md) to get started.
132132
133133
## Access Serial Console for Linux
134134
In order for serial console to function properly, the guest operating system must be configured to read and write console messages to the serial port. Most [Endorsed Azure Linux Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros) have the serial console configured by default. Simply clicking the Serial Console section in the Azure portal will provide access to the console.
@@ -143,6 +143,15 @@ SUSE | Newer SLES images available on Azure have console access enabled b
143143
Oracle Linux | Oracle Linux images available on Azure have console access enabled by default.
144144
Custom Linux images | To enable serial console for your custom Linux VM image, enable console access in /etc/inittab to run a terminal on ttyS0. Here is an example to add this in the inittab file: `S0:12345:respawn:/sbin/agetty -L 115200 console vt102`. For more information on properly creating custom images see [Create and upload a Linux VHD in Azure](https://aka.ms/createuploadvhd).
145145
146+
## Accessibility
147+
Accessibility is a key focus for the Azure serial console. To that end, we have ensured that the serial console is accessible for those with visual and hearing impairments, as well as people who may not be able to use a mouse.
148+
149+
### Keyboard navigation
150+
Use the `tab` key on your keyboard to navigate around the serial console interface within the Aure portal. Your location will be highlighted on screen. To leave the focus of the serial console blade, press `Ctrl + F6` on your keyboard.
151+
152+
### Use serial console with a screen reader
153+
Serial console comes with screen reader support built in. Navigating around with a screen reader turned on will allow the alt text for the currently selected button to be read aloud by the screen reader.
154+
146155
## Errors
147156
Most errors are transient in nature and retrying the serial console connection often addresses these. The table below shows a list of errors and mitigations
148157

articles/virtual-machines/windows/serial-console.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For serial console documentation for Linux VMs, [click here](../linux/serial-con
3636
* Virtual machine MUST have [boot diagnostics](boot-diagnostics.md) enabled
3737

3838
![](../media/virtual-machines-serial-console/virtual-machine-serial-console-diagnostics-settings.png)
39-
39+
4040
* The account using the serial console must have [Contributor role](../../role-based-access-control/built-in-roles.md) for VM and the [boot diagnostics](boot-diagnostics.md) storage account.
4141
* The virtual machine for which you are acessing serial console must also have a password-based account. You can create one with the [reset password](https://docs.microsoft.com/azure/virtual-machines/extensions/vmaccess#reset-password) functionality of the VM access extension - see the screenshot below.
4242

@@ -75,7 +75,7 @@ If needed SAC can be enabled offline as well,
7575

7676
If [SAC] (https://technet.microsoft.com/library/cc787940(v=ws.10).aspx) is not enabled the serial console will not show the SAC prompt. It can show a VM Health information in some cases or it would be blank.
7777

78-
### Enabling boot menu to show in the serial console
78+
## Enabling boot menu to show in the serial console
7979

8080
If you need to enable Windows boot loader prompts to show in the serial console, you can add the following additional options to Windows boot loader.
8181

@@ -147,6 +147,15 @@ If a user is connected to serial console and another user successfully requests
147147
>[!CAUTION]
148148
This means that the user who gets disconnected will not be logged out! The ability to enforce a logout upon disconnect (via SIGHUP or similar mechanism) is still in the roadmap. For Windows, there is an automatic timeout enabled in SAC, however for Linux you can configure terminal timeout setting.
149149
150+
## Common scenarios for accessing serial console
151+
Scenario | Actions in serial console
152+
:------------------|:-----------------------------------------
153+
Incorrect firewall rules | Access serial console and fix Windows firewall rules.
154+
Filesystem corruption/check | Access serial console and recover filesystem.
155+
RDP configuration issues | Access serial console and change settings. Go to the [RDP documentation](https://docs.microsoft.com/windows-server/remote/remote-desktop-services/clients/remote-desktop-allow-access) to get started.
156+
Network lock down system| Access serial console via portal to manage system. Some network commands are listed in the [Serial Console CMD and PowerShell documentation](./serial-console-cmd-ps-commands.md).
157+
Interacting with bootloader | Access BCD via the serial console. Go to [Enabling boot menu to show in the serial console](#enabling-boot-menu-to-show-in-the-serial-console) to get started.
158+
150159
## Using Serial Console for NMI calls in Windows VMs
151160
A non-maskable interrupt (NMI) is designed to create a signal that software on a virtual machine will not ignore. Historically, NMIs have been used to monitor for hardware issues on systems that required specific response times. Today, programmers and system administrators often use NMI as a mechanism to debug or troubleshoot systems which are hung.
152161
@@ -156,6 +165,14 @@ The Serial Console can be used to send a NMI to an Azure virtual machine using t
156165
157166
For information on configuring Windows to create a crash dump when it receives an NMI, see: [How to generate a complete crash dump file or a kernel crash dump file by using an NMI on a Windows-based system](https://support.microsoft.com/en-us/help/927069/how-to-generate-a-complete-crash-dump-file-or-a-kernel-crash-dump-file)
158167
168+
## Accessibility
169+
Accessibility is a key focus for the Azure serial console. To that end, we have ensured that the serial console is accessible for those with visual and hearing impairments, as well as people who may not be able to use a mouse.
170+
171+
### Keyboard navigation
172+
Use the `tab` key on your keyboard to navigate around the serial console interface within the Aure portal. Your location will be highlighted on screen. To leave the focus of the serial console blade, press `Ctrl + F6` on your keyboard.
173+
174+
### Use serial console with a screen reader
175+
Serial console comes with screen reader support built in. Navigating around with a screen reader turned on will allow the alt text for the currently selected button to be read aloud by the screen reader.
159176
160177
## Errors
161178
Most errors are transient in nature and retrying connection address these. The table below shows a list of errors and mitigations

0 commit comments

Comments
 (0)