Difference between revisions of "Management Console"

From PrgmrWiki
m (Reverted edits by Will (talk) to last revision by Paul)
(Logging in via MobaXterm (Windows))
 
(17 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
__FORCETOC__
 
__FORCETOC__
  
= Logging in from an OpenSSH Client (Linux, Windows Cygwin) or Terminal (OS X) =  
+
= Logging in via OpenSSH Client (Linux, Windows Cygwin or Command Line) or Terminal (OS X) =  
 
To login to the console, use the command
 
To login to the console, use the command
 
<pre>
 
<pre>
ssh -i <secret key> <user>@<user>.console.xen.prgmr.com
+
ssh -i <secret key> <hostname>@<hostname>.console.xen.prgmr.com
 
</pre>
 
</pre>
 +
 +
The hostname is the name assigned to your VPS.
  
 
If this is your first time logging in, use the [https://prgmr.com/public_keys.txt server public key list] to verify the server fingerprint based on IP address.
 
If this is your first time logging in, use the [https://prgmr.com/public_keys.txt server public key list] to verify the server fingerprint based on IP address.
 +
 +
'''Note for macOS:''' Beginning with macOS Sierra (June 2016), DSA keys are no longer supported. Use Terminal to [[Making an ssh key|generate a new RSA ssh key]] and [[SSH Security#Using openssh keys|upload your new public key to your server]].
  
 
= Logging in via PuTTY Client (Windows only) =
 
= Logging in via PuTTY Client (Windows only) =
  
If you are unable to connect, please verify your version of PuTTY is up to date (0.64 or newer). You want to be using 0.64 or newer anyway since private keys were not completely wiped from memory before 0.64.<br>
+
If you are unable to connect, please verify your version of PuTTY is up to date (0.64 or newer). You want to be using 0.64 or newer anyway since private keys were not completely wiped from memory before 0.64.
  
 
Starting from initial defaults the PuTTY Configuration settings are as follows:
 
Starting from initial defaults the PuTTY Configuration settings are as follows:
Line 22: Line 26:
 
<li> "Connection/SSH/Auth:Private key file for authentication" needs to point to the .ppk file associated with the public key used.</li>
 
<li> "Connection/SSH/Auth:Private key file for authentication" needs to point to the .ppk file associated with the public key used.</li>
 
</ul>
 
</ul>
Under "Session:Saved Sessions", name this session "Management for <vpsname>.xen.prgmr.com" and save. Click open to connect to the management console.<br>
+
Under "Session:Saved Sessions", name this session "Management for <vpsname>.xen.prgmr.com" and save. Click open to connect to the management console.
 +
 
 
You may use this [http://prgmr.com/vps.console.xen.prgmr.com.reg.txt registry file] as a starting point, however PLEASE open it with a text editor and review it before importing. Use at your own risk.
 
You may use this [http://prgmr.com/vps.console.xen.prgmr.com.reg.txt registry file] as a starting point, however PLEASE open it with a text editor and review it before importing. Use at your own risk.
  
 
If this is your first time logging in, use the [https://prgmr.com/public_keys.txt server public key list] to verify the server fingerprint based on IP address.
 
If this is your first time logging in, use the [https://prgmr.com/public_keys.txt server public key list] to verify the server fingerprint based on IP address.
  
= Using =
+
= Logging in via MobaXterm (Windows) =  
Once you log in, you see this menu (here, the domain is called cnryfield:)
+
For more information on downloading and installing MobaXterm, see [https://mobaxterm.mobatek.net/download-home-edition.html here].
 +
 
 +
If you have not generated an SSH key pair, see [https://wiki.prgmr.com/mediawiki/index.php/Making_an_ssh_key here]
 +
 
 +
To log in to the management console...
 +
# Launch MobaXterm.
 +
# Click the "Session" button on the left end of the tool bar. This will launch the Session Settings window.
 +
# Select "SSH" in the upper left.
 +
# Under "Basic SSH Settings," click "Remote Host" field and enter your host address: [username].console.xen.prgmr.com.
 +
# Click the "Specify Username" checkbox. In the field to the right enter your Prgmr.com username (the name of your service). Use lower case for the username.
 +
# Select the "Advanced SSH Settings" Tab. Leave the defaults as the are, but click the "Use Private Key" checkbox. In the field to the right, click the Browse icon to navigate to your SSH private key. (See above to generate a key pair if you have not done so.) In Windows, the default location is C:\Users\[Windows Username]\.ssh\[Key File].
 +
# In the "Session Settings" window click "OK" to launch your session and log in to your service. If prompted to do so, enter the passphrase for SSH key, defined when you generated the key pair.
 +
 
 +
MobaXterm will log you in and provide a terminal window for your session.
 +
 
 +
If this is your first time logging in, use the [https://prgmr.com/public_keys.txt server public key list] to verify the server fingerprint based on IP address.
 +
 
 +
= Using the Console =
 +
 
 +
(Note that this wiki page describes the "new" console, which is now the normal case.)
 +
 
 +
At log in, the initial menu for a service named 'nite' is shown below:
  
 
<pre>
 
<pre>
Name                                        ID  Mem VCPUs State Time(s)
+
Main Menu - nite
cnryfield                                  218  1024    1    r-----    1898.8
 
  
    Wiki at http://wiki.prgmr.com
+
Current status:
    Please contact support@prgmr.com with any issues accessing your machine.
+
nite is not running.
  
    Options for "cnryfield"
+
Wiki at http://wiki.prgmr.com
    1. out of band console (press ctrl-] to escape, not resizeable)
+
Please contact support@prgmr.com with any issues accessing your machine.
    2. create/start, opens OOB console (try this if the machine is not running)
 
    3. shutdown (requests operating system to shut down)
 
    4. force power off (destroy/hard shutdown)
 
    5. reboot (requests operating system to reboot)
 
    6. swap i386/amd64 bootloaders currently "i386"
 
    7. view/add/remove ssh authorized_keys
 
    8. set reverse dns
 
    9. swap pvgrub/grub2 bootloaders currently "pv-grub"
 
  
    0. exit
+
Options:
</pre>
+
1. out of band console (press ctrl-] to escape, not resizeable)
 +
2. create/start, opens OOB console (try this if the machine is not running)
 +
3. shutdown (requests clean shutdown, forces off after 4 min)
 +
4. force power off (destroy/hard shutdown)
 +
5. reboot (shutdown + start)
 +
6. set bootloader, rescue mode, or netboot installer
 +
7. view/add/remove ssh authorized_keys
 +
8. view/edit reverse dns
 +
9. install new OS image
 +
a. system details
 +
b. maintenance options
 +
 
 +
0. Exit
 +
R. refresh
 +
 
 +
enter selection></pre>
  
<b>Option 1</b> can be used to access the serial console when the domain is running. Like other serial consoles, often you see nothing until you use ctrl-c or hit return, at which point you should see the normal login prompt
+
<b>Option 1</b> accesses the serial console when the VPS is running. Like other serial consoles, often you see nothing until you use ctrl-c or hit return, at which point you should see the normal login prompt
  
 
<pre>
 
<pre>
Line 57: Line 89:
 
Kernel 2.6.18-53.1.14.el5xen on an i686
 
Kernel 2.6.18-53.1.14.el5xen on an i686
  
cnryfield login:  
+
nite login:  
 
</pre>
 
</pre>
  
 
To exit the console once at the login screen shown above in most terminals, the escape sequence is ctrl+].
 
To exit the console once at the login screen shown above in most terminals, the escape sequence is ctrl+].
  
<b>Option 2</b> should be used when the domain is not running. Before printing the menu the script runs the xen command showing the status of the domain. Example output from when the domain is not running:
+
<b>Option 2</b> starts the VPS if it's not running and opens the serial console.
 +
 
 +
<b>Option 3</b> attempts to nicely shut down the VPS. It sends a shutdown request to the server, like briefly pressing the power button of a physical machine. If the system does not shut down within 4 minutes, it will force a shutdown (like Option 4).
 +
 
 +
<b>Option 4</b> forces the VPS to shut down, like holding down the power button of a physical machine for several seconds.
 +
 
 +
<b>Option 5</b> stops and then starts the VPS. It is like a combination of Options 3 and 2, in that it will force a shutdown after 4 minutes.
 +
 
 +
<b>Option 6</b> changes what is used to boot the VPS. This is the option that differs most between different virtualization types ([[#Option 6 in HVM and PV|see below]]).
 +
 
 +
<b>Option 7</b> adds or removes ssh keys authorized to access this menu.  It will not change the keys within the VPS as we have a policy of not modifying user disk images.
 +
 
 +
<b>Option 8</b> modifies reverse DNS, i.e. the DNS name that comes back from typing 'host <myip>' .
 +
 
 +
<b>Option 9</b> installs a new OS image. It will repartition and reformat before the install. The currently authorized SSH keys may optionally be added to the root user as part of the install.
 +
 
 +
<b>Option a</b> brings up a system information panel, as below:
 
<pre>
 
<pre>
Domain cnryfield is not running.
+
Command result:
 +
Virtualization mode: Paravirtualized
 +
Memory: 128 MiB
 +
VCPUs: 1
 +
Total disk: 3 GiB
 +
IPs: 192.168.0.91
 +
Last installed OS: Debian Wheezy - 64 bit
 +
Boot option: PV-GRUB - 64 bit
 +
Boot arguments: (hd0,0)/boot/grub/menu.lst
 
</pre>
 
</pre>
  
<b>Option 3</b> is used to nicely shut down the domain, like hitting the power button of a physical machine briefly.
+
<b>Option b</b> allows you to change the [[Live Migration|live migration]] options for your VPS.
 +
<pre>
 +
Options:
 +
1. Enable live migration
 +
2. Disable live migration
 +
 
 +
0. Return to main menu
 +
R. refresh
 +
 
 +
enter selection>
 +
</pre>
 +
Live migration is enabled by default. If you are running certain distros or certain kernel versions (see link above) then you may wish to disable live migration.
 +
 
 +
 
 +
<b>Option 0</b> ends the ssh session.
  
<b>Option 4</b> is used to force the domain to shut down, like holding down the power button of a physical machine for several seconds.
+
<b>Option R</b> refreshes this menu.
  
<b>Option 5</b> requests the domain to reboot.  Note that if your IPs have changed since the last time you started the machine, you will need to do a shutdown (3) or destroy (4) instead of just a reboot.
+
=== Option 6 ===
 +
Use these menus to change the way the VPS boots. By default an HVM VPS boots from disk, while a paravirtualized(PV) VPS boots using either PV-GRUB or GRUB2.
  
<b>Option 6</b> should be used if you are reinstalling your OS with a different architecture; almost all operating systems come in 32 bit (i386) and 64 bit (amd64) flavors.
+
==== Boot options - HVM ====
 +
In HVM systems, pressing option 6 will bring up the following menu:
  
<b>Option 7</b> should be used if you wish to add or remove ssh keys authorized to access this menu.  It will not change the keys on your domain as we have a policy of not modifying user disk images.
+
<pre>
 +
Set Boot Options - nite
  
<b>Option 8</b> allows you to modify reverse DNS, IE the dns name that comes back when you type 'host <myip>' .
+
Configured to boot from disk.
  
<b>Option 9</b> allows switching between legacy grub (pv-grub) and grub2.  
+
Options:
 +
1. Boot from disk
 +
2. External Bootloaders
 +
3. Linux-based Live Rescue
 +
4. Linux netboot installers - install mode
 +
5. Linux netboot installers - rescue mode
 +
6. BSD installers
  
<b>Option 0</b> will end the ssh session.
+
0. Return to main menu
 +
R. refresh
  
 +
enter selection>
 +
</pre>
 +
 +
==== Boot options - Paravirtualized ====
 +
In PV systems, pressing option 6 will bring up the following menu:
 +
<pre>
 +
Set Boot Options - nite
 +
 +
Configured to boot 'PV-GRUB - 64 bit' with arguments '(hd0,0)/boot/grub/menu.lst'
 +
 +
Options:
 +
1. GRUB legacy(pv-grub)
 +
2. GRUB2
 +
3. Linux-based Live Rescue
 +
4. Linux netboot installers - install mode
 +
5. Linux netboot installers - rescue mode
 +
6. BSD netboot installers
 +
 +
0. Return to main menu
 +
R. refresh
 +
 +
enter selection>
 +
</pre>
 
{{c|for Users}}
 
{{c|for Users}}
 
{{c|Getting Started}}
 
{{c|Getting Started}}
 
{{c|Prgmr}}
 
{{c|Prgmr}}

Latest revision as of 06:26, 26 October 2020

When you sign up, you give us an OpenSSH format public key. This key gives you access to simple text-based menu that lets you turn your domain on, off, and allows you to connect to the serial console. If you need help on how to make a key, please refer to Making an ssh key.


Logging in via OpenSSH Client (Linux, Windows Cygwin or Command Line) or Terminal (OS X)

To login to the console, use the command

ssh -i <secret key> <hostname>@<hostname>.console.xen.prgmr.com

The hostname is the name assigned to your VPS.

If this is your first time logging in, use the server public key list to verify the server fingerprint based on IP address.

Note for macOS: Beginning with macOS Sierra (June 2016), DSA keys are no longer supported. Use Terminal to generate a new RSA ssh key and upload your new public key to your server.

Logging in via PuTTY Client (Windows only)

If you are unable to connect, please verify your version of PuTTY is up to date (0.64 or newer). You want to be using 0.64 or newer anyway since private keys were not completely wiped from memory before 0.64.

Starting from initial defaults the PuTTY Configuration settings are as follows:

  • "Session:Host Name" needs to be <vpsname>.console.xen.prgmr.com, example "icecream.console.xen.prgmr.com" for a VPS named "icecream"
  • "Session:Connection type" needs to be SSH
  • "Connection/Data: Auto-login username" needs to be <vpsname>, example "icecream" for a VPS named "icecream"
  • "Connection/SSH/Auth:Private key file for authentication" needs to point to the .ppk file associated with the public key used.

Under "Session:Saved Sessions", name this session "Management for <vpsname>.xen.prgmr.com" and save. Click open to connect to the management console.

You may use this registry file as a starting point, however PLEASE open it with a text editor and review it before importing. Use at your own risk.

If this is your first time logging in, use the server public key list to verify the server fingerprint based on IP address.

Logging in via MobaXterm (Windows)

For more information on downloading and installing MobaXterm, see here.

If you have not generated an SSH key pair, see here

To log in to the management console...

  1. Launch MobaXterm.
  2. Click the "Session" button on the left end of the tool bar. This will launch the Session Settings window.
  3. Select "SSH" in the upper left.
  4. Under "Basic SSH Settings," click "Remote Host" field and enter your host address: [username].console.xen.prgmr.com.
  5. Click the "Specify Username" checkbox. In the field to the right enter your Prgmr.com username (the name of your service). Use lower case for the username.
  6. Select the "Advanced SSH Settings" Tab. Leave the defaults as the are, but click the "Use Private Key" checkbox. In the field to the right, click the Browse icon to navigate to your SSH private key. (See above to generate a key pair if you have not done so.) In Windows, the default location is C:\Users\[Windows Username]\.ssh\[Key File].
  7. In the "Session Settings" window click "OK" to launch your session and log in to your service. If prompted to do so, enter the passphrase for SSH key, defined when you generated the key pair.

MobaXterm will log you in and provide a terminal window for your session.

If this is your first time logging in, use the server public key list to verify the server fingerprint based on IP address.

Using the Console

(Note that this wiki page describes the "new" console, which is now the normal case.)

At log in, the initial menu for a service named 'nite' is shown below:

Main Menu - nite

Current status:
	nite is not running.

Wiki at http://wiki.prgmr.com
Please contact support@prgmr.com with any issues accessing your machine.

Options:
1. out of band console (press ctrl-] to escape, not resizeable)
2. create/start, opens OOB console (try this if the machine is not running)
3. shutdown (requests clean shutdown, forces off after 4 min)
4. force power off (destroy/hard shutdown)
5. reboot (shutdown + start)
6. set bootloader, rescue mode, or netboot installer
7. view/add/remove ssh authorized_keys
8. view/edit reverse dns
9. install new OS image
a. system details
b. maintenance options

0. Exit
R. refresh

enter selection>

Option 1 accesses the serial console when the VPS is running. Like other serial consoles, often you see nothing until you use ctrl-c or hit return, at which point you should see the normal login prompt

CentOS release 5.2 (Final)
Kernel 2.6.18-53.1.14.el5xen on an i686

nite login: 

To exit the console once at the login screen shown above in most terminals, the escape sequence is ctrl+].

Option 2 starts the VPS if it's not running and opens the serial console.

Option 3 attempts to nicely shut down the VPS. It sends a shutdown request to the server, like briefly pressing the power button of a physical machine. If the system does not shut down within 4 minutes, it will force a shutdown (like Option 4).

Option 4 forces the VPS to shut down, like holding down the power button of a physical machine for several seconds.

Option 5 stops and then starts the VPS. It is like a combination of Options 3 and 2, in that it will force a shutdown after 4 minutes.

Option 6 changes what is used to boot the VPS. This is the option that differs most between different virtualization types (see below).

Option 7 adds or removes ssh keys authorized to access this menu. It will not change the keys within the VPS as we have a policy of not modifying user disk images.

Option 8 modifies reverse DNS, i.e. the DNS name that comes back from typing 'host <myip>' .

Option 9 installs a new OS image. It will repartition and reformat before the install. The currently authorized SSH keys may optionally be added to the root user as part of the install.

Option a brings up a system information panel, as below:

Command result: 
	Virtualization mode: Paravirtualized
	Memory: 128 MiB
	VCPUs: 1
	Total disk: 3 GiB
	IPs: 192.168.0.91
	Last installed OS: Debian Wheezy - 64 bit
	Boot option: PV-GRUB - 64 bit
	Boot arguments: (hd0,0)/boot/grub/menu.lst

Option b allows you to change the live migration options for your VPS.

Options:
1. Enable live migration
2. Disable live migration

0. Return to main menu
R. refresh

enter selection>

Live migration is enabled by default. If you are running certain distros or certain kernel versions (see link above) then you may wish to disable live migration.


Option 0 ends the ssh session.

Option R refreshes this menu.

Option 6

Use these menus to change the way the VPS boots. By default an HVM VPS boots from disk, while a paravirtualized(PV) VPS boots using either PV-GRUB or GRUB2.

Boot options - HVM

In HVM systems, pressing option 6 will bring up the following menu:

Set Boot Options - nite

Configured to boot from disk.

Options:
1. Boot from disk
2. External Bootloaders
3. Linux-based Live Rescue
4. Linux netboot installers - install mode
5. Linux netboot installers - rescue mode
6. BSD installers

0. Return to main menu
R. refresh

enter selection>

Boot options - Paravirtualized

In PV systems, pressing option 6 will bring up the following menu:

Set Boot Options - nite

Configured to boot 'PV-GRUB - 64 bit' with arguments '(hd0,0)/boot/grub/menu.lst'

Options:
1. GRUB legacy(pv-grub)
2. GRUB2
3. Linux-based Live Rescue
4. Linux netboot installers - install mode
5. Linux netboot installers - rescue mode
6. BSD netboot installers

0. Return to main menu
R. refresh

enter selection>