Help Docs

Start, stop, reboot, and rebuild WorkSpaces

Using Site24x7's IT automation framework, you can create an action profile to stop, start, reboot and rebuild your WorkSpaces. Configure the automation to be triggered when there is a change in the status of the monitor or individual attributes.

Required Permissions

Please make sure the IAM role assumed by Site24x7 or the IAM user created for Site24x7 has the following partial write actions in the attached policy document to perform the actions.

  • workspaces:StartWorkspaces
  • workspaces:RebootWorkspaces
  • workspace:RebuildWorkspaces
  • workspaces:StopWorkspaces

Constraints

  • For you to start a WorkSpace, it must be monitored by Site24x7 and the status must be AVAILABLE.
  • You can stop a WorkSpace only if it is in the running state.

Create an action profile

  • Login to the Site24x7 web console, select Admin > IT Automation Templates
  • Click on Add Automation and select Start/Stop/Reboot/Rebuild Wrokspace as the type by clicking on the drop down.
  • Type in an unique name in the Display Name field.
  • Click on the drop down and select the action to be performed (Start, stop, reboot or rebuild)
  • Next, select the WorkSpace where you want the action to be performed. 
  • Max Allowed Action Execution Time: The maximum number of seconds Site24x7 has to wait before the request times out. The execution time is set at 15 seconds, by default. You can define an execution time between 1-90 seconds.
  • Send the Automation Result via Email: You can choose to receive an email regarding the automation result, by setting the toggle button to Yes. Share automation results via an email to your User Alert Group configured in the Notification Profile. This email will contain parameters including the automation name, type of automation, incident reason, destination hosts, and more.
  • Save the profile.

Simulate the Automation

Before mapping the action profile, you can test it's functionality by invoking the action manually within the Site24x7 console or by using our REST APIs. Once you've created the profile, navigate back to the IT Automation summary page and click on the play button to execute a test run.

Map the Action Profile

To execute the automation, map the action profile to an desired alert event. You can either map the profile to a predefined monitor level event type (Up/Down/trouble) or to an custom attribute level event type(The number of users connected exceeds 30).

Monitor level mapping

Navigate to the Edit monitor page of the monitored WorkSpace (“WorkSpaces monitor list page" > WorkSpace > Edit) , and map the action profile with any of the following monitor status changes.

  • Execute on Down
  • Execute on Up
  • Execute on Trouble
  • Execute on Critical
  • Execute on any Status change
  • Execute on any attribute Status change

Attribute level mapping

You can also associate the action profile to a related performance metric like sessions connected, unhealthy WorkSpaces or session launch time. Navigate to the Edit threshold profile page of the monitored WorkSpace(Navigate to the Edit Monitor page of the resource > click on the Pencil icon adjacent to the Threshold and Availability field) and map the profile to any desired attribute by clicking on the "Select Automation to Execute" field.

Usecase

When your WorkSpace encounters system errors or difficulty in completing a update, all functions come to a standstill. Im such cases, you can rebuild your WorkSpace and this will restore your WorkSpace to the last image of the bundle it was launched from.

Was this document helpful?

Would you like to help us improve our documents? Tell us what you think we could do better.


We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.


Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!