cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [44/50] [abbrv] git commit: updated refs/heads/ldapplugin to bdba0dd
Date Fri, 30 Aug 2013 23:28:37 GMT
Added Accessing System VM via SSH


Branch: refs/heads/ldapplugin
Commit: f5e7f46dadda741f10e5b674d0578ade9ba719d7
Parents: 5275618
Author: Marty Sweet <>
Authored: Sun Aug 25 13:17:51 2013 +0100
Committer: David Nalley <>
Committed: Fri Aug 30 09:00:34 2013 -0400

 docs/en-US/accessing-system-vms.xml         |  66 +++++++++++++++++++++++
 docs/en-US/images/view-systemvm-details.png | Bin 0 -> 25483 bytes
 docs/en-US/working-with-system-vm.xml       |   1 +
 3 files changed, 67 insertions(+)
diff --git a/docs/en-US/accessing-system-vms.xml b/docs/en-US/accessing-system-vms.xml
new file mode 100755
index 0000000..e1b6090
--- /dev/null
+++ b/docs/en-US/accessing-system-vms.xml
@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" ""
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+<section id="accessing-system-vms">
+    <title>Accessing System VMs</title>
+    <para>It may sometimes be necessary to access  System VMs for diagnostics of certain
issues, for example if you are experiencing SSVM (Secondary Storage VM) connection issues.
Use the steps below in order to connect to the SSH console of a running System VM.</para>
+    <para>
+    Accessing System VMs over the network requires the use of private keys and connecting
to System VMs SSH Daemon on port 3922.
+    XenServer/KVM Hypervisors store this key at /root/.ssh/ on each &PRODUCT;
+    To access System VMs running on ESXi, the key is stored on the management server at /var/lib/cloudstack/management/.ssh/id_rsa.
+    </para>
+    <orderedlist>
+      <listitem>
+        <para>Find the details of the System VM</para>
+        <orderedlist numeration="loweralpha">
+          <listitem><para>Log in with admin privileges to the &PRODUCT; UI.</para></listitem>
+          <listitem><para>Click Infrastructure, then System VMs, and then click
the name of a running VM.</para></listitem>
+          <listitem><para>Take a note of the 'Host', 'Private IP Address' and
'Link Local IP Address' of the System VM you wish to access.</para></listitem>
+        </orderedlist>
+        <para><inlinegraphic format="PNG" fileref="images/view-systemvm-details.png"/></para>
+      </listitem>
+      <listitem>
+        <para>XenServer/KVM Hypervisors</para>
+        <orderedlist numeration="loweralpha">
+          <listitem><para>Connect to the Host of which the System VM is running.</para></listitem>
+          <listitem><para>SSH the 'Link Local IP Address' of the System VM from
the Host on which the VM is running.</para></listitem>
+          <listitem><para>Format: ssh -i &lt;path-to-private-key&gt;
&lt;link-local-ip&gt; -p 3922</para></listitem>
+          <listitem><para>Example: root@faith:~# ssh -i /root/.ssh/ -p 3922</para></listitem>          
+        </orderedlist>
+      </listitem>
+      <listitem>
+        <para>ESXi Hypervisors</para>
+        <orderedlist numeration="loweralpha">
+          <listitem><para>Connect to your &PRODUCT; Management Server.</para></listitem>
+          <listitem><para>ESXi users should SSH to the private IP address of
the System VM.</para></listitem>
+          <listitem><para>Format: ssh -i &lt;path-to-private-key&gt;
&lt;vm-private-ip&gt; -p 3922</para></listitem>
+          <listitem><para>Example: root@management:~# ssh -i /var/lib/cloudstack/management/.ssh/id_rsa -p 3922</para></listitem>
+        </orderedlist>
+       </listitem>
+    </orderedlist>
diff --git a/docs/en-US/images/view-systemvm-details.png b/docs/en-US/images/view-systemvm-details.png
new file mode 100755
index 0000000..bce270b
Binary files /dev/null and b/docs/en-US/images/view-systemvm-details.png differ
diff --git a/docs/en-US/working-with-system-vm.xml b/docs/en-US/working-with-system-vm.xml
index 70f7dd1..073d077 100644
--- a/docs/en-US/working-with-system-vm.xml
+++ b/docs/en-US/working-with-system-vm.xml
@@ -32,6 +32,7 @@
       parameter on the &PRODUCT; UI or by calling the listConfigurations API.</para>
   <xi:include href="system-vm-template.xml" xmlns:xi=""/>
+  <xi:include href="accessing-system-vms.xml" xmlns:xi=""/>
   <xi:include href="multiple-system-vm-vmware.xml" xmlns:xi=""/>
   <xi:include href="console-proxy.xml" xmlns:xi=""/>
   <xi:include href="virtual-router.xml" xmlns:xi=""/>

View raw message