PaulAngus closed pull request #4: Add run diagnostics to admin guide and new
apis
URL: https://github.com/apache/cloudstack-documentation/pull/4
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/source/_static/images/diagnostics-form.png
b/source/_static/images/diagnostics-form.png
new file mode 100644
index 0000000..a9b0b37
Binary files /dev/null and b/source/_static/images/diagnostics-form.png differ
diff --git a/source/_static/images/run-diagnostics-icon.png
b/source/_static/images/run-diagnostics-icon.png
new file mode 100644
index 0000000..61e2aac
Binary files /dev/null and b/source/_static/images/run-diagnostics-icon.png
differ
diff --git a/source/adminguide/systemvm.rst b/source/adminguide/systemvm.rst
index 286e5e4..4c3da98 100644
--- a/source/adminguide/systemvm.rst
+++ b/source/adminguide/systemvm.rst
@@ -552,3 +552,44 @@ The administrator can log in to the secondary storage VM
if needed.
:alt: Updating Console Proxy SSL Certificate
.. |vr-upgrade.png| image:: /_static/images/vr-upgrade.png
:alt: Button to upgrade VR to use the new template.
+
+Troubleshoot networks from System VMs
+-------------------------------------
+.. |run-diagnostics-icon.png| image:: /_static/images/run-diagnostics-icon.png
+.. |diagnostics-form.png| image:: /_static/images/diagnostics-form.png
+
+For troubleshooting of network issues in CloudStack hosted networks,
CloudStack allows
+the administrator to execute network-utility commands (ping, traceroute or
arping)
+remotely on system VMs.
+
+To run either a ping, traceroute or arping through the CloudStack UI:
+
+#. As an administrator, log in to the CloudStack UI.
+
+#. Navigate to Infrastructure > System VMs or Virtual Routers.
+
+#. Click on the Run Diagnostics button. |run-diagnostics-icon.png|
+
+#. A form will pop up similar to this;
+ |diagnostics-form.png|
+#. Fill in the details and click OK.
+
+The Extra Args parameter is for specifying command line optional parameters
+as one would when executing any of the tools from the terminal or command line.
+
+The supported versions are Debian 9 based since system VMs are built using the
+same Debian 9 based templates.
+
+| See:
+| Traceroute(1):
https://manpages.debian.org/stretch/traceroute/traceroute.1.en.html
+| Ping(8): https://manpages.debian.org/stretch/iputils-ping/ping.8.en.html
+| Arping(8): https://manpages.debian.org/stretch/arping/arping.8.en.html
+
+
+Non-Alphanumeric characters (metacharacters) are not allowed for this parameter
+except for the “-“ and the “.”. Any metacharacter supplied will immediately
result
+in an immediate termination of the command and report back to the operator
that an illegal character was passed
+
+
+
+
diff --git a/source/releasenotes/api-changes.rst
b/source/releasenotes/api-changes.rst
index b666b39..ea0ec1f 100644
--- a/source/releasenotes/api-changes.rst
+++ b/source/releasenotes/api-changes.rst
@@ -118,7 +118,8 @@ New API Commands
+---------------------------------------------+--------------------------------------------------------------------------------+
| ``releasePodIpAddress`` | Releases a Pod IP back to the
Pod |
+---------------------------------------------+--------------------------------------------------------------------------------+
-
+| ``runDiagnostics`` | Run network-utility commands
remotely on system VMs |
++---------------------------------------------+--------------------------------------------------------------------------------+
Parameters Changed API Commands
-------------------------------
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
