Configure a Module

At Modules, you can configure Modules. Modules are containers for the Tasks that you can execute on Agents. Modules hold information about how these Tasks should be executed, such as Task settings, order of execution of Tasks, parameters and conditions.

Navigation

When viewing, specifying, changing or duplicating the configuration details of a Module, the same Module Details page opens.

  • At Modules > click New.
  • At Modules, click an existing Module to view the details.
  • At Modules, click an existing Module, change the configuration and click Save.
  • At Modules, click an existing Module, select Duplicate from the Module Details.

Configuration

Properties tab

  • Use the Properties tab to specify a name and an optional description for the Module.
  • The Module Name is the name that is displayed in the Modules overview.
  • The Module Description is only shown in the list view. In the Description field, you can create hyperlinks (http://, https://, file://) when in edit mode (click edit_mode). The users can directly browse to these hyperlinks from the Management Portal when in read only mode (click read_mode).
  • In the Folder field you can optionally specify in which folder (and subfolder) the Module is grouped.
  • If a Module is disabled, you can no longer directly schedule it in a Job. However, if a Module is disabled, it is still enabled in Projects and Run Books. It is, however, not possible to create new Projects and Run Books containing that Module.
  • Use the option Leave used Resources in Agent cache after Module is finished only for Resources that are frequently used by the Agents and that rarely change. This allows Agents to execute Tasks faster, because they don't need to download the Resources from a Dispatcher first.

Tasks tab

  • Use the Tasks tab to manage the Tasks in a Module. From here, you can add, edit, duplicate and delete one or more Tasks. Tasks are actions that you can perform on an Agent. With a Task you can, for example, install software on Agents, manage users and groups in Active Directory, query security risks on Agents or query mailboxes on Microsoft Exchange servers. See also Task Overview and Add a new Task.
    • To change the order of execution of Tasks in the Module, select a Task and use the Arrow buttons. Likewise, use the arrow buttons to move any separators up or down the list of Tasks.
    • To create sets of Jobs, add a separator to have a visual aid to enhance readability in Modules that contain many Tasks; they do not affect the execution order of Tasks.
  • Conditional: whether (true) or not (false) conditions are applied to this Task. Conditions determine whether a Job should be executed, skipped or failed.
  • To view or set conditions on a Task:
    • Click the icon (condition_yes or condition_no) in the Conditional column or select Condition from the puntjes for the relevant Task. See also Conditions.

Parameters tab

  • Use the Parameters tab to have an overview of the parameters of all Tasks used in the Module. From here, you can add, edit, rearrange, delete and cleanup your parameters. See also Parameters.

Usage tab

  • Use the Usage tab to view in which Project(s), Run Book(s) and/or Team(s) the Module is used.

Job History tab

  • Use the Job History tab to view details of Jobs in which the Module was used.
  • Use the Filter to limit the results on status, date (range) and Job invoker.

Versioning tab

  • Use the Versioning tab to view a list of changes made to the Module, including all known versions of the Module. See Version Control.
  • Click the expand (collapse_arrow_right) button to view the details of the change grouped by date.
  • Click the browse (browse) button from the Current Version field to change the version number manually.

Trusts tab

  • Use the Trusts tab to define trusted Agents and Teams for the Module. This tab is only shown if Trusts Security has been enabled. See also Trusts.

Permissions tab

  • Use the Permissions tab to view the level of access that Console users have to the Module.
  • Use the option Do not allow this Module to be scheduled programmatically to allow the Module from being invoked via the Console only. When selected, it will no longer be possible to invoke the Module:
    • During unattended installations of an Agent (by applying properties to its MSI).
    • Via Ivanti Workspace.


See also

Task overview