This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/main by this push:
new f91ee7d Add docs for scheduling operations on a VM (#313)
f91ee7d is described below
commit f91ee7dd99b36e65daf4478451a47e4b70bfcb0c
Author: Vishesh <[email protected]>
AuthorDate: Mon Jun 26 13:37:25 2023 +0530
Add docs for scheduling operations on a VM (#313)
---
source/_static/images/vm-schedule-form.png | Bin 0 -> 108567 bytes
source/_static/images/vm-schedule-tab.png | Bin 0 -> 275940 bytes
source/adminguide/virtual_machines.rst | 57 +++++++++++++++++++++++++++++
3 files changed, 57 insertions(+)
diff --git a/source/_static/images/vm-schedule-form.png
b/source/_static/images/vm-schedule-form.png
new file mode 100644
index 0000000..f49fd8e
Binary files /dev/null and b/source/_static/images/vm-schedule-form.png differ
diff --git a/source/_static/images/vm-schedule-tab.png
b/source/_static/images/vm-schedule-tab.png
new file mode 100644
index 0000000..9fe8ec4
Binary files /dev/null and b/source/_static/images/vm-schedule-tab.png differ
diff --git a/source/adminguide/virtual_machines.rst
b/source/adminguide/virtual_machines.rst
index 76a12da..18d3ba0 100644
--- a/source/adminguide/virtual_machines.rst
+++ b/source/adminguide/virtual_machines.rst
@@ -299,6 +299,59 @@ This includes the virtual machine’s IP address.
Managing Virtual Machines
=========================
+Scheduling operations on a VM
+-------------------------------------
+
+After a VM is created, you can schedule VM lifecycle operations using cron
expressions. The operations that can be scheduled are:
+
+- Start
+- Stop
+- Reboot
+- Force Stop
+- Force Reboot
+
+To schedule an operation on a VM through the UI:
+
+#. Log in to the CloudStack UI as a user or admin.
+
+#. In the left navigation, click Instances.
+
+#. Click the VM that you want to schedule the operation on.
+
+#. On the VM details page, click the **Schedule** button. |vm-schedule-tab.png|
+
+#. Click on **Add schedule** button to add a new schedule or click on Edit
button |EditButton.png| to edit
+ an existing schedule. |vm-schedule-form.png|
+
+#. Configure the schedule as per requirements:
+
+ - **Description**: Enter a description for the schedule. If left empty,
it's generated on the basis of action and the schedule.
+
+ - **Action**: Select the action to be triggered by the schedule. Can't be
changed once the schedule has been created.
+
+ - **Schedule**: Select the frequency using cron format at which the action
should be triggered.
+ For example, `* * * * *` will trigger the job every minute.
+
+ - **Timezone**: Select the timezone in which the schedule should be
triggered.
+
+ - **Start Date**: Date at the specified time zone after which the schedule
becomes active.
+ Defaults to current timestamp plus 1 minute.
+
+ - **End Date**: Date at the specified time zone before which the schedule
is active.
+ If not set, schedule won't become inactive.
+
+ .. note::
+ It's not possible to remove the end date once it's configured.
+
+
+
+#. Click OK to save the schedule.
+
+ .. note::
+ If multiple schedules are configured for a VM and the scheduled time
coincides, then only the schedule which was created first
+ will be executed and the rest will be skipped.
+
+
Changing the VM Name, OS, or Group
-------------------------------------
@@ -1382,6 +1435,10 @@ VM disk statistics are shown in the Metrics tab in an
individual volume view, as
.. |vm-lifecycle.png| image:: /_static/images/vm-lifecycle.png
:alt: Virtual Machine State Model
+.. |vm-schedule-tab.png| image:: /_static/images/vm-schedule-tab.png
+ :alt: Virtual Machine Schedule Tab
+.. |vm-schedule-form.png| image:: /_static/images/vm-schedule-form.png
+ :alt: Virtual Machine Schedule Form
.. |VMSnapshotButton.png| image:: /_static/images/VMSnapshotButton.png
:alt: button to restart a VPC
.. |delete-button.png| image:: /_static/images/delete-button.png
