Axcient Help Center

Creating Runbooks

Runbooks allow you to configure an automatic deployment plan for virtualized devices in the Virtual Office. You must first configure a subnet in the Network section that matches the subnet of the devices to be virtualized. By default, the subnet settings in the Network section are set by the network settings of the Appliance.

Runbooks can be leveraged for the following use cases:

  • Test Disaster Recovery – Create a Runbook to test the user’s disaster recovery plan in the event of a real disaster situation. This will help address any potential issues that may arise so that if a disaster occurs, the user will experience no issues with deploying a production Virtual Office.

  • Production Disaster Recovery – Create a Runbook to automatically deploy a production Virtual Office with all the desired devices and configurations. The user will require the help of Axcient Support to help shut down the Virtual Office when ready.

Configuring a Runbook will allow you to configure:

  • Devices to be virtualized

  • The order in which the devices should be virtualized

  • Resources to allocate to each device

  • Wait time between the deployment of each device

Create a New Runbook

To create a new Runbook:

  1. On the Site Details page, click the Manage Runbooks link found in the Virtualization section of the page.

    ManageRunnbooks1.jpg
  2. In the Create a New Runbook section of the page, enter the name of the new Runbook.

    Optionally, enter a description for the Runbook.

    Click the Next button to continue.

    RunbookStart.jpg
  3. In the Add Devices screen, use the checkboxes to select the devices to include in the Runbook. Click the Next button to continue.

    Note

    Note: The Virtual Office will automatically select the most recent recovery point to use in deploying the Virtual Office.

    runbook_SelectVMs.jpg
  4. In the Edit Values section, review the selected devices. Click the Edit and Delete buttons to edit or delete any of the devices. You will be able to edit the following:

    1. In the Priority tab, specify the boot priority of the selected device(s). Devices with the same boot priority will be started at the same time.

    2. In the CPU Cores tab, specify the number of CPU cores to allocate to the selected device(s).

    3. In the VM Ram tab, edit the amount of virtual RAM to allocate to the selected device(s).

    4. In the Wait Time tab, edit the delay time between boot priority. For example, if you have a device with a Medium boot priority and a 15 minute wait time, and then a second device with a Low boot priority, the Runbook will wait 15 minutes before deploying the Low priority device. You can also configure different wait times between devices with the same priority.

    5. Click the Save button when you are finished.

      Runbook_Edit.jpg
  5. In the Network screen, you can configure the following:

    1. In the Network section, configure the Gateway IP and Netmask of the Virtual Office. Please refer to the Configure Virtual Office section for more information.

    2. In the VNC IP section, enter the IP address for the VNC clients, which can be any available (unused) IP address in the Virtual Office. This field is optional when you configure the network in the Runbook. If you leave this field blank, it will be filled in automatically after the Runbook is created from the first subnet. Please refer to the Configure Virtual Office section for more information.

    3. Optionally, enable the Outbound Access option to allow outbound access to the Internet. Please refer to the Configure Virtual Office section for more information.

    4. Click the Next button to continue.

      Network1.jpg
  6. In the Advanced Settings section, you can enable and configure the following methods for accessing devices in the Virtual Office:

    • VPN

    • User Authentication

    • Port Forwarding

    • DHCP

    • Site-to-Site VPN

    • Site-to-Site IPSec VPN

    Click the Next button to continue.

    Runbook_Options.jpg

    Note

    You can also update these settings after the Runbook has started from the Configure Office page. Please refer to the Configure Virtual Office section for more information.

  7. In the Finish Runbook screen, review summary information to confirm that the Runbook settings are correct. Click the Finish Creating Runbook button to create the Runbook.

    The Runbook will now be listed under the Runbook Summary section where you can edit or delete the Runbook as needed.

    RunbookComplete1.jpg
Clone a Runbook

You can optionally clone a Runbook, which allows you to create a new Runbook from an existing Runbook and make changes where needed. Cloning a Runbook is a quick and easy way to create a new Runbook with slightly different settings.

To clone a Runbook:

  1. On the Site Details page, click the Manage Runbooks link found in the Virtualization section of the page.

    ManageRunnbooks1.jpg
  2. In the Runbook Summary section of the page, use the checkboxes to select the Runbook you want to clone and then click the Clone Runbook button.

    CloneRunbook.PNG
  3. In the Clone Runbook screen, review the name of the new Runbook and then click the Clone button.

    CloneRunbook1.PNG
  4. In the Edit Runbook tab, you can optionally edit the settings inherited from the original Runbook. For example, you can add or remove devices, change values, update network settings, and more. Click the Next button to move through each step of the editing process.

    CloneRunbook2.png
  5. When you are finished making changes, click the Finish Creating Runbook button.

Start a Runbook

You can start a Runbook in one of the following ways:

  • On the Site or Service page, click the Recover button and then select a Runbook.

  • On the Runbook page, select a Runbook and then click the Run Runbook button.

A Runbook cannot be started under the following circumstances:

  • A Virtual Office or Runbook is already running under the Site

    Runbooks are Site-specific, and only a single Runbook may be running at a time for any given Site. If a Runbook is already running under a Site, the user will be unable to deploy a second Runbook.

  • No Subnet is configured in the Runbook for at least one device

    A subnet must be configured for at least one of the devices in the Runbook in order to start the Runbook. If no subnet is configured for any devices in the Runbook, the Runbook will not start.

If a subnet is configured for only one or some of the devices, you will need to create the additional subnets in the Virtual Office Configuration page in order to virtualize the remaining devices when the Runbook is in a Running state.

Additionally, you can edit the Runbook to create any additional subnets. The devices with subnets created after the Runbook has been deployed will not adhere to the device boot order configured in the Runbook.

This example will start on the Runbook page.

  1. On the Site Details page, click the Manage Runbooks link found in the Virtualization section of the page.

    ManageRunnbooks.jpg
  2. In the Runbook Summary section of the page, use the checkboxes to select the Runbook and then click the Run Runbook button.

    RUnbook_Select.jpg
  3. On the Start Runbook screen, select the type of Virtual Office to deploy (Test or Production).

    StartRunbook.jpg
  4. The Runbook will start and the Starting Runbook screen will display the progress. You can click the Close button to leave the screen while the Runbook starts.

    RunbookClose.jpg
Edit a Runbook

You can edit a Runbook whenever needed, including when the Runbook is inactive and when it is running.

While a Runbook is inactive, all aspects of the Runbook and Virtual Office can be edited; however, not all aspects of the Runbook can be edited while the Runbook is running. For example, you cannot edit included devices when the Runbook is running, but you can edit network information.

If the Runbook is running, you can incorporate changes on the Advanced Settings page. However, these changes will not apply until you restart the Runbook. Additionally, if you update Virtual Office settings from the Runbook, the settings will not change for the running Runbook.

To edit a Runbook:

  1. On the Site Details page, click the Manage Runbooks link found in the Virtualization section of the page.

    ManageRunnbooks.jpg
  2. In the Runbook Summary section of the page, use the checkboxes to select the Runbook and then click the Edit Runbook button.

    Runbook_Edit2.jpg
  3. Update the Runbook as appropriate.

Delete a Runbook

When a Runbook is deleted, it will not be recoverable.

To delete a Runbook:

  1. On the Site Details page, click the Manage Runbooks link found in the Virtualization section of the page.

    ManageRunnbooks.jpg
  2. In the Runbook Summary section of the page, use the checkboxes to select the Runbook and then click the Delete Runbook button. The Runbook is now permanently deleted.

    Runbook_Delete.jpg