Tools steps

This group of steps includes any type of steps usable as 'tools' for other operations.

Change the Lock Window Message

This step customizes the text of the message box that appears when locking the remote device.

Parameter

Description

Message Text

Enter into this field the text to be displayed in the message box on the screen.

Check Agent Version

This step checks the version number of the currently installed agent.

Parameter

Description

Version

Enter into this field the version number that the agent should have.

Verify that the Device is Not the Master

This step verifies that the device is not the Master.

No parameters need to be defined for this step.

Check Operating System

This step verifies if the operating system of the target device corresponds to one of those selected in the step's list.

Parameter

Description

Windows 10 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 10. You may select more than one OS.

Windows 10 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 10. You may select more than one OS.

Windows 8.1 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 8.1 . You may select more than one OS.

Windows 8.1 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 8.1. You may select more than one OS.

Windows 8 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 8. You may select more than one OS.

Windows 8 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 8. You may select more than one OS.

Windows 7 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 7. You may select more than one OS.

Windows 7 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 7. You may select more than one OS.

Windows 2016 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64-bit Windows 2016. You may select more than one OS.

Windows 2012 R2 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 2012 R2. You may select more than one OS.

Windows 2012 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 2012. You may select more than one OS.

Windows 2008 R2 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 2008 R2. You may select more than one OS.

Windows 2008 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows 2008. You may select more than one OS.

Windows 2008 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 2008. You may select more than one OS.

Pre-Windows 7 Versions

Parameter

Description

Windows Vista (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows Vista. You may select more than one OS.

Windows Vista (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows Vista. You may select more than one OS.

Windows XP (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Windows XP. You may select more than one OS.

Windows XP (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows XP. You may select more than one OS.

Windows ME

Check this box if the operating system to which the OS of the target device must correspond is Windows ME. You may select more than one OS.

Windows 98

Check this box if the operating system to which the OS of the target device must correspond is Windows 98. You may select more than one OS.

Windows 95

Check this box if the operating system to which the OS of the target device must correspond is Windows 95. You may select more than one OS.

Windows 2003 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64-bit Windows 2000. You may select more than one OS.

Windows 2003 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Windows 2003. You may select more than one OS.

Windows 2000

Check this box if the operating system to which the OS of the target device must correspond is Windows 2000. You may select more than one OS.

Windows NT

Check this box if the operating system to which the OS of the target device must correspond is Windows NT. You may select more than one OS.

Linux and Mac

Parameter

Description

Mac OS X

Check this box if the operating system to which the OS of the target device must correspond is a MAC OS.

Ubuntu (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Ubuntu. You may select more than one OS.

Ubuntu (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Ubuntu. You may select more than one OS.

Red Hat Linux Release 9 (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Red Hat Release 9. You may select more than one OS.

Red Hat Linux Release 9 (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Red Hat Release 9. You may select more than one OS.

Red Hat Enterprise Linux (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Red Hat Enterprise Linux. You may select more than one OS.

Red Hat Enterprise Linux (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Red Hat Enterprise Linux. You may select more than one OS.

CentOS (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Cent OS. You may select more than one OS.

CentOS (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Cent OS. You may select more than one OS.

SuSe (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit SUSE. You may select more than one OS.

SuSe (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit SUSE. You may select more than one OS.

Debian (64 bit)

Check this box if the operating system to which the OS of the target device must correspond is 64 bit Debian. You may select more than one OS.

Debian (32 bit)

Check this box if the operating system to which the OS of the target device must correspond is 32 bit Debian. You may select more than one OS.

Other Linux (32 & 64 bit)

Check this box if the operating system to which the OS of the target device must correspond is any other Linux version (32 and/or 64 bit) not specifically mentionend in this list. You may select more than one OS.

Solaris

Check this box if the operating system to which the OS of the target device must correspond is Solaris.

Execute Operational Rule

This step executes an operational rule on the target device. Be aware that the rule must already be available on the respective device, otherwise this step will fail.

Parameter

Description

Execute Once

Defines if the operational rule is to be executed only once or if it is to follow the schedule defined at the time of its assignment:

  • If the schedule for the operational rule exists but is deactivated it is activated.
  • If there is no more schedule assigned to the rule (this may be the case for example if the rule was schedule to execute three times, and these three executions have already been done), the original schedule is reactivated. In this case, if the original schedule is deactivated, this option does not reactivate it.

Operational Rule Name

Enter the name of the operational rule to be executed.

Generate Custom Alert

This step generates a custom alert.

Parameter

Description

Alert Description

Description of the alert to be sent. The values within the parenthesis are data that is replaced during execution. The description can contain environment variables (${}).

Alert Severity

Select the severity to be assigned to the alert.

Alert Sub-category

Enter the sub-category to which the alert is to be added. Be aware that this sub-category name may not have more that 64 characters.

Lock Device

This step locks the mouse and keyboard of the device. Once the operation necessitating the lock is terminated, it must always be followed by the unlock step, otherwise the remote device will remain locked.

Parameter

Description

Message Text

Enter the text to be displayed in the message box on the screen.

Reboot Device

This step reboots a client with any of the supported operating systems. This step ignores if a reboot window is assigned to the device and does not increase the reboot count.

No parameters need to be defined for this step.

Send Extended Mail

This step sends an email with extended capabilities to a predefined address.

Parameter

Description

Attachments

Contains a list of files that are to be attached to the mail. The individual paths, preferable absolute paths, must be separated by commas (,) and must be local to the sending device.

Allow Login Protocol

Check this box if the mail server requires login authentication.

Allow Plain Text Protocol

Check this box if the mail server requires plain text authentication.

Allow CRAM-MD5 Protocol

Check this box if the mail server requires CRAM-MD5 authentication.

Password

The corresponding password. This parameter is mandatory if the option Force Authentication or Authenticate if possible is selected for the Authentication Policy parameter.

Authentication Policy

Defines if the mail server requires authentication for its communication.

User Name

Enter a valid login to the mail server. This may be any login, not necessarily that of the user defining his preferences in via these options. This field is mandatory if the option Force Authentication or Authenticate if possible is selected for the Authentication Policy parameter.

BCC

This parameter is optional as well and may contain the address of the blind carbon copy recipient to be added to the mail message.

CC

This parameter is optional and may contain the address of the carbon copy recipient to be added to the mail message.

Allow SSLv2 Protocol

Check this box if the mail server requires SSLv2 encryption.

Allow SSLv3 Protocol

Check this box if the mail server requires SSLv3 encryption.

Allow TLSv1 Protocol

Check this box if the mail server requires TLSv1 encryption.

Ciphering Policy

Defines if the mail server requires encryption for its communication.

From

Enter the name of the sender into this field.

Message Text

Enter into this field the text to be added to the message part of the mail message.

MIME Header

Allows you to define a MIME type, that is to be used for sending the mail. To indicate for example that the body of the message is in HTML format use the following header: Content-Type:text/html; charset .

Port Number

Enter the name of the mail server, as defined in the Mail tab in the System Variables of the Global Settings .

Server Name

Enter into this field the name of the mail server, as defined in the Mail tab in the System Variables of the Global Settings . The name may either be entered as the full or short network name such as mail or mail.enterprise.starfleet.com or as its IP address in dotted notation, for example, 213.2.146.1 or 2001:db8:85a3::8a2e:370:7334 .

Subject

Defines the text of the subject field or title of the mail.

To

Enter the email address of the recipient to which the mail is to be sent.

Send Mail

This step sends an email to a predefined address.

Parameter

Description

BCC

This parameter is optional as well and may contain the address of the blind carbon copy recipient to be added to the mail message.

CC

This parameter is optional and may contain the address of the carbon copy recipient to be added to the mail message.

From

Enter the name of the sender into this field.

Message Text

Enter into this field the text to be added to the message part of the mail message.

Port Number

Enter the name of the mail server, as defined in the Mail tab in the System Variables of the Global Settings .

Server Name

Enter into this field the name of the mail server, as defined in the Mail tab in the System Variables of the Global Settings . The name may either be entered as the full or short network name such as mail or mail.enterprise.starfleet.com or as its IP address in dotted notation, for example, 213.2.146.1 or 2001:db8:85a3::8a2e:370:7334 .

Subject

Defines the text of the subject field or title of the mail.

To

Enter the email address of the recipient to which the mail is to be sent.

Send SNMP Traps

This steps allows to send SNMP traps with a maximum of three trap variables (varbinds) to an SNMP server.

Parameter

Description

Community

Contains the community string used when sending SNMP traps to the agent, for example, public.

Destination Name

Enter the address of the host the trap is sent to inform of an IP address in dotted notation, for example, 213.2.146.1 or 2001:db8:85a3::8a2e:370:7334 .

Organization ID

Enter the OID of the management enterprise that defines the trap message, for example, 1.3.6.1.4.1.976 .

Parameter Type 1

Defines the type of the variable through its numeric representative:

  • 1: Object ID (SNMP_OID)
  • 2: String (SNMP_STR)
  • 3: Integer (SNMP_INT)

Parameter Value 1

Enter the actual value for the trap variable in form of a string.

Parameter Type 2

Defines the type of the variable through its numeric representative:

  • 1: Object ID (SNMP_OID)
  • 2: String (SNMP_STR)
  • 3: Integer (SNMP_INT)

Parameter Value 2

Enter the actual value for the trap variable in form of a string.

Parameter Type 3

Defines the type of the variable through its numeric representative:

  • 1: Object ID (SNMP_OID)
  • 2: String (SNMP_STR)
  • 3: Integer (SNMP_INT)

Parameter Value 3

Enter the actual value for the trap variable in form of a string.

Specify Type Identifier

Defines the type of the specific enterprise trap message through its numeric representative, for example, 10200 .

Standard Type Identifier

Defines the standard type of the trap message through its numeric representative: 0 = coldStart, 1 = warmStart, 2 = linkDown, 3 = linkUp, 4 = authenticationFailure, 5 = egpNeighborLoss and 6 = enterpriseSpecific.

Port

The port number on which the target listens for incoming traps.

Shutdown Device

This step allows you to completely shut down a client with any of the supported operating systems.

Parameter

Description

Clear Virtual Memory Pagefile

Determines whether the virtual memory pagefile should be cleared when the system is shut down. Enabling this security option also causes the hibernation file (hiberfil.sys) to be zeroed out when hibernation is disabled on a laptop system. When this policy is disabled, the virtual memory pagefile is not cleared during system shutdown.

Allow System to be Shut Down without Having to Log On

Determines whether a computer can be shut down without having to log on to Windows. When this policy is enabled, the Shut Down command is available on the Windows login screen. When this policy is disabled, the option to shut down the computer does not appear on the Windows login screen. In this case, users must be able to log on to the computer successfully and have the Shut down the system user right in order to perform a system shutdown.

Unlock Device

This step allows to unlock the mouse and keyboard of the device. This step must always be used after the operation for which the device was locked has finished, otherwise the remote device will remain locked. Be also aware, that, if the step is executed after a step with the stop on error option activated and the step fails, this step will not be executed and the remote device will remain locked.

No parameters need to be defined for this step.

Verify Last Device Boot Time

This step checks the uptime of a device, i.e., the time since the device was last booted and compares it with a specified maximum device uptime.

Parameter

Description

Max. Timeframe (min)

Specifies the maximum number of minutes that may have elapsed since the device booted for the last time. If the device uptime exceeds this value, a step error is returned.

Wait

This step stops the execution of the operational rule for a defined number of seconds before resuming the operation.

Parameter

Description

Seconds to Wait

Specifies the number of seconds to halt the execution before continuing.

Wait for Days

This step allows you to halt the execution of the operational rule for a number of days before continuing. This action fails if the number of specified days is exceeded and succeeds in the opposite case. Be aware, that for this step the Stop Condition parameter must be set to Stop on successful step.

Parameter

Description

Counter Identifier

Allows several operational rule assignments to use this step to interact between them. If for example, a rule is scheduled for each 10th of the month as well as every Tuesday (via two assignments), and it is requested, that it waits for 7 days, the rule executing on the 10th updates the common counter. This means, that the rule executing on Tuesday 13th takes the counter into consideration.

Days to Wait

Specifies the number of days to halt the execution before continuing.

Wake on LAN

This step launches a wake up call to a list of defined target clients to remote power on these devices.

Parameter

Description

Number of Retries

Defines the number of retries the step is to execute before abandoning if it fails.

Retry Interval (sec)

Defines the interval at which the step is to effect its retries in seconds.

IP Address List

Defines the list of IP addresses of the target machines, separated by a comma (,).

MAC Address List

The list of MAC addresses of the target machines, separated by a comma (,). This list must be in the same order as the IP address list and have the same number of addresses which must correspond to the IP addresses listed above.

Was this page helpful? Yes No Submitting... Thank you

Comments