Override the reboot behaviour policy for an individual Software Delivery Job

Document ID : KB000050001
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

Problem

  • Need to deploy a job which can reboot immediately even though configuration policy defines different settings for prompt, postpone etc.,

Environment

  • CA Client Automation r12.5

  • CA IT Client Manager r12.5 r12.0, r11.2

  • CA Software Delivery r12.5 r12.0, r11.2

Solution:

Reboot Related Macros

The following macros can be added to the command line of the procedure or as user parameters for the job container, provided the command line of the procedure accepts user parameters, which is enabled by the $up macro. During job evaluation and build, the manager looks for these macros. If they are found they will be removed from the command line and transformed into job definition properties, which are sent to the agents.

  • $rto:value

    Defines the timeout in seconds for the shutdown dialog, where value is a numeric value greater than 0. If not set, the value is defined by configuration policy. If set, both initial timeout and every consecutive postpone use the value.

    • This macro is used by logoff and reboot routines.

    • Overrides policy: ITRM/USD/Agent/RebootPromptTO.

  • $rrt:value

    Defines the number of allowed postpones, where value is a numeric value equal to or greater than 0. If not set, the value is defined by configuration policy.

    • This macro is used by logoff and reboot routines.

    • Overrides policy: ITRM/USD/Agent/RebootPromptRT.

  • $rbp:value

    Specifies if a message should be displayed to the user before reboot or logoff is initiated. The value is 0 or 1. If not set, the value is defined by configuration policy. If set to 1, a requested reboot or logoff will not be initiated automatically. Instead a message is displayed prompting the user to save all work. The message does not have a timer and can only be closed by the user. By closing the message the shutdown is initiated.

    • This macro is used by logoff and reboot routines.

    • Overrides policy: ITRM/USD/Agent/PoliteReboot.

  • $rbf:value

    Specifies if shutdown should be forced, where value is 0 or 1. If not set, the value is defined by configuration policy. If set to 1, the shutdown routine will force programs to shutdown.

    • This macro is used by logoff and reboot routines.

    • Overrides policy: ITRM/USD/Agent/ForcedReboot.

      Example: The macros are used without using user parameters
      Procedure command line: "setup.exe $rto:50 $rrt:0 $rbp:0 $rbf:1"
      Example: The macros are used with the use of user parameters
      Procedure command line: "setup.exe $up"
      Job user parameters: "$rto:50 $rrt:0 $rbp:0 $rbf:1"

Logoff/Reboot after last job behavior:

Due to the boot option "Logoff/Reboot After Last" it may happen that more than one job may want to influence the boot parameters used. Another scenario when this approach will be used is if the reboot parameters are specified for a job for which no Logoff or Reboot is requested. In this case the rules are as follows:

  • $rto: If more than one job carries the parameter the most restrictive will be used. This means the lowest timeout will be used.

  • $rrt: If more than one job carries the parameter, the most restrictive will be used. This means the lowest count will be used.

  • $rbp: If more than one job carries the parameter, the most restrictive will be used. This means that $rbp:0 will override $rbp:1.

  • $rbf: If more than one job carries the parameter, the most restrictive will be used. This means that $rbf:1 will override $rbf:0.

Compatibility considerations:

The reboot override functionality requires CA ITCM r11.2. If the manager is r11.2 but the scalability servers or the agents are pre-r11.2, the reboot override functionality does not work and the default configuration is used by the agent. If the manager is not r11.2, the macros will remain on the command line and eventually get passed as regular parameters to the installer which is launched by the agent.