Ask the Community
Groups
Creating and scheduling runbooks - Connect IT Community | Kaseya
<main> <article class="userContent"> <p><em>For partners subscribed to the current Enterprise plan.</em></p> <p>To view and print client data collected in IT Glue as runbooks, follow these instructions. The runbooks feature gives you the ability to create offline asset documentation for disaster recovery, compliance, reporting, and offboarding purposes. You can also schedule runbooks to be generated as needed.</p> <p>IT Glue Runbooks are generated as single PDFs including two main sections: Core Assets and Flexible Assets. Content in runbooks are automatically generated for you so there is nothing to configure except when it contains masked password values to protect private information.</p> <p>Prefer to view your data in spreadsheets? We also make it easy to <a rel="nofollow" href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fkaseya.vanillacommunities.com%2Fkb%2Farticles%2Faliases%2Fitglue%2Fhc%2Fen-us%2Farticles%2F360004938978">export to CSV</a>.</p> <p>Prerequisites</p> <ul><li>You must have Administrator access to IT Glue to access the runbooks feature</li> <li>You must have an account on the current Enterprise plan</li> </ul><p>Instructions</p> <h3 data-id="creating-a-runbook">Creating a runbook</h3> <ol><li>Navigate to <strong>Account > Runbooks</strong>. In the <strong>Select Organizations </strong>selection, start typing to search for organizations and sub-organizations. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/CI2T2SUS91VX/runbooks-it-glue.png" alt="Runbooks___IT_Glue.png" class="embedImage-img importedEmbed-img"></img></p> </li> <li>Click to select each organization you want to generate a runbook for. Other functions: <ul><li>Click the trash can icons to remove organizations one-by-one or,</li> <li>Click the <strong>Remove All</strong> button to clear the field.<br><p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/HS8NI871P6GQ/runbooks-it-glue.png" alt="Runbooks___IT_Glue.png" class="embedImage-img importedEmbed-img"></img></p> </li> <li>Click the <strong>All Organizations</strong> toggle switch to create runbooks for every organization in your account. These will all appear together in a zipped folder. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/RU75F0WF2TDS/runbooks-it-glue-1.png" alt="Runbooks___IT_Glue__1_.png" class="embedImage-img importedEmbed-img"></img></p> </li> </ul></li> <li>By default, the <strong>Mask Passwords</strong> switch is turned on. Leaving this option on will automatically redact passwords in the runbook PDF, meaning asterisks will replace all passwords. Turning this option off will display passwords in human-readable format. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/W8E2HUYZ7OAH/runbooks-it-glue-2.png" alt="Runbooks___IT_Glue__2_.png" class="embedImage-img importedEmbed-img"></img></p> </li> <li>Click the <strong>Submit</strong> button to start creating the runbook(s).</li> <li>Click the <strong>View Runbooks</strong> tab to see the job status. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/SYVOTHAXKIU5/runbooks-view-runbooks.png" alt="Runbooks_View_Runbooks.png" class="embedImage-img importedEmbed-img"></img></p> </li> <li>Once the runbook status changes from <strong>In Progress</strong> to <strong>Complete</strong>, click the <strong>Download </strong>button. This opens your downloads folder where you will find either a PDF or a zip file containing multiple PDFs depending on the selections you made in previous steps. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/G98VCIMHBEF5/runbooks-download.png" alt="Runbooks_Download.png" class="embedImage-img importedEmbed-img"></img></p> </li> </ol><p>You will also receive an email alert when your runbook is ready for download. Just click the <strong>View completed Runbooks</strong> link in the email and you'll be taken directly to where you can download the file(s).<br><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/JMGL19P7M1TD/runbooks-emails-2.png" alt="Runbooks_Emails-2.png" class="embedImage-img importedEmbed-img"></img></p> <p><strong>Additional notes</strong></p> <ul><li>While a job is in progress, no other job can be started.</li> <li>If you generate a single runbook, it will typically be ready to download in a very short time depending on the requested data and system load.</li> <li>If you generate runbooks for multiple organizations, processing may take a while, so please be patient. Remember, we'll email you when it's ready.</li> <li>Once a runbook is available to download, you have 24 hours before it is deleted. After that time, you will need to create a new runbook.</li> </ul><h3 data-id="scheduling-the-automatic-creation-of-a-runbook">Scheduling the automatic creation of a runbook</h3> <p>IT Glue Runbooks allows you to schedule runbooks to be generated at a future date and time.</p> <ol><li>Start creating a new runbook following steps 1 to 3 in the previous section.</li> <li>Click on the <strong>Schedule</strong> option, select the date from the calendar and, set the time you want the runbook to start generating. By default, the date will be today's date and the time will be set a half hour or more in the future. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/PW3QOQF5BC6E/runbooks-it-glue-3.png" alt="Runbooks___IT_Glue__3_.png" class="embedImage-img importedEmbed-img"></img></p> </li> <li>Click the <strong>Next Step</strong> button to continue creating your runbook and click <strong>Submit</strong> when you're done.</li> </ol><h3 data-id="adding-a-recurrence">Adding a recurrence</h3> <p>If you wish to create the same runbook on a regular schedule, simply add a recurrence. In the <strong>Schedule</strong> dialog, click the <strong>Recurring</strong> checkbox. A new dialog opens allowing you to choose a weekly or monthly recurrence.</p> <ol><li> <strong> Weekly</strong> <ol type="a"><li>Choose how many weeks apart you want the runbook to generate.</li> <li>Choose the day of the week the runbook will generate on.</li> <li>Choose when this recurrence will end.</li> <li>Review the summary before clicking <strong>Next Step</strong>. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/NZODRELMWIZB/runbooks-it-glue-4.png" alt="Runbooks___IT_Glue__4_.png" class="embedImage-img importedEmbed-img"></img></p> </li> </ol></li> <li> <strong> Monthly</strong> <ol type="a"><li>Choose how many months apart you want the runbook to generate.</li> <li>Choose the day of the month the runbook will generate on.</li> <li>Choose when this recurrence will end.</li> <li>Review the summary before clicking <strong>Next Step</strong>. <p><br><img src="https://us.v-cdn.net/6032361/uploads/migrated/64AWEOL23I8X/1.png" alt="1.png" class="embedImage-img importedEmbed-img"></img></p> </li> </ol></li> </ol><h3 data-id="managing-your-scheduled-runbooks">Managing your scheduled runbooks</h3> <p>Click the <strong>View Runbooks</strong> tab to view all your scheduled runbooks. You will be taken to a page that list all jobs. Any scheduled runbooks will be listed at the very bottom of this screen. You can click the <strong>Edit</strong> button to make changes in each individual runbook schedule.</p> <p><img src="https://us.v-cdn.net/6032361/uploads/migrated/IC9K05M8H309/view-runbooks.png" alt="View_Runbooks.png" class="embedImage-img importedEmbed-img"></img></p> <h3 data-id="cancelling-a-runbook">Cancelling a runbook</h3> <p>To cancel a job that has not yet finished processing, go to the <strong>View Runbooks</strong> tab. The current job will be listed first in the list. Click the <strong>Cancel</strong> button.</p> <p>To cancel a scheduled runbook, go to the <strong>View Runbooks</strong> tab and scroll down to the <strong>Scheduled</strong> section. Click the <strong>Cancel</strong> button to cancel any future runbooks that have not yet started.</p> </article> </main>