Run Books

At Library > Run Books, you can configure and manage Run Books. If you find yourself repeatedly scheduling the same sequences of Modules and Projects on different Agents or Teams, you can combine these Modules and Projects into a Run Book. This makes Job scheduling easier.

With Run Books, you can create a chain of Jobs that makes it unnecessary to schedule these Jobs individually. Because each Job in the chain can be performed by a different Agent, a Run Book can perform all the steps for a specific maintenance Task. This is very useful in complex maintenance tasks in which, for example, a computer needs to be set up for a newly hired employee, an ERP server needs to be backed up, or all servers in a Citrix server farm need to reboot sequentially.

Because you can let each step depend on the results of the previous step, you can create predictable results: with Run Books, maintenance Tasks can only performed in one way, based on best practices. It is as if you are saying: "In this particular scenario, the following Job should be performed on this computer, the next Job on that computer, the next Job on these computers, then the next Job on this computer, etc."

You can schedule a Run Book as if it were a normal Job.


  • Use the Folders tab to group Run Books in folders. Grouping Run Books in folders can be useful in large environments and multi-tenant Ivanti Automation sites to easily locate any Run Books you have created and also to create folders for various needs.
  • If you delete a folder, its contents will be deleted as well.
  • Use the Run Books tab to view a alphabetical list of all Run Books, without the folder structure.
  • To create a duplicate of a Run Book, select it and click Duplicate in the command bar. Creating duplicates of a Run Book is useful when you need to create a new Run Book that only slightly differentiates from an already existing Run Book. By changing the values and settings of a duplicated Run Book, you can customize it to your needs. This saves configuration time.
  • To create a Ivanti Identity Director service based on a Run Book, see this Identity Director help topic.
  • When saving changes to the Run Book, the Version Control window will be opened. This window makes it possible to configure the versioning of changes to the Run Book. The availability of this window depends on the global setting Use silent versioning.
  • After modifying a Run Book, a notification window will open if the Run Book is used in a scheduled Job. Provided you have sufficient permissions to the Scheduling node, you can use this window to open the scheduled Job and reload the relevant Tasks, if necessary.

When configuring a Run Book:

  • Use the Properties tab to specify a name and an optional description for the Run Book.
  • Use the Jobs tab to manage the Jobs in the Run Book.
  • Use the Run Book Parameters tab to manage the Job parameters in the Run Book.
  • Use the Job History tab to view details of Jobs in which the Run Book was used and to reschedule these Jobs if necessary.
  • Use the Versioning tab to view a list of changes made to the Run Book, including all known versions of the Run Book.
  • Use the Permissions tab to view the level of access that Console users have to the Run Book.