Create new Scheduler Task in Configuration Policy

Products

• CA Client Automation - IT Client Manager
• CA Client Automation

Issue/Introduction

In the Configuration Policy there are 6 tasks under DSM/Common Components/CAF/Scheduler :

Refresh Location Aware
Refresh registration
Run Mirrorsync
Run the UAM agent
Run the UAM agent in USD hint mode
Run the USD agent

These tasks are available on the machines by checking the properties of the Common Agent from caf systray icon:

How to create another task ?

Environment

Client Automation - All Versions

Resolution

1- Create a file new_scheduler_task.xml with following xml lines :

<configuration>
 <allusers>
  <paramsection name="itrm">
   <paramsection name="common">
    <paramsection name="caf">
     <paramsection name="scheduler">
      
      <paramsection name="amagentschedule2">
        <attribute name="helpid">9000</attribute>
        <attribute name="dis_en">Run the UAM agent 2</attribute>
        
        <parameter name="commandline" value="start amagent">
          <attribute name="dis_en">CAF Scheduler: command line</attribute>
          <parameterinfo name="pi_commandline">
            <attribute name="type">string</attribute>
            <attribute name="desc">The caf command which performs this job</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="enabled" value="0">
          <attribute name="dis_en">CAF Scheduler: Enabled</attribute>
          <parameterinfo name="pi_enabled">
            <attribute name="type">bool</attribute>
            <attribute name="desc">Set to true if this job is enabled</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="type" value="day">
          <attribute name="dis_en">CAF Scheduler: Type of Job</attribute>
          <parameterinfo name="pi_type">
            <attribute name="type">string</attribute>
            <attribute name="desc">Type of schedule interval. Possible values are: day, hour and minute. You can also add a number of optional qualifiers. Add "random" to run the job with a random time added to the specified time, up to the value of randomminutes. Add random_hour to run at a random hour during the day. Add random_minute to run at a random minute during the hour. Add "now" to run the job within "randomnowtime" seconds. Multiple values are separated by spaces.</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="excludedays" value="">
          <attribute name="dis_en">CAF Scheduler: Days to exclude</attribute>
          <parameterinfo name="pi_excludedays">
            <attribute name="type">string</attribute>
            <attribute name="desc">The list of days which are excluded from the schedule. You can specify any combination of monday, tuesday, wednesday, thursday, friday, saturday and sunday. Names are separated by spaces.</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="excludehours" value="">
          <attribute name="dis_en">CAF Scheduler: Hours to exclude</attribute>
          <parameterinfo name="pi_excludehours">
            <attribute name="type">string</attribute>
            <attribute name="desc">The list of hours which are excluded from the schedule. You can specify hours using the 24 hour clock. Hours are separated by spaces.</attribute>
            <attribute name="incl">1,2,3,4,5,6,7,8,9,0, ,</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="hour" value="1">
          <attribute name="dis_en">CAF Scheduler: Hour</attribute>
          <parameterinfo name="pi_hour">
            <attribute name="type">int</attribute>
            <attribute name="desc">For daily schedules, this value is the hour at which the job runs. For hourly and minute schedules it is not used.</attribute>
            <attribute name="incl">1,2,3,4,5,6,7,8,9,0,</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="minute" value="0">
          <attribute name="dis_en">CAF Scheduler: Minute</attribute>
          <parameterinfo name="pi_minute">
            <attribute name="type">int</attribute>
            <attribute name="desc">For daily and hourly jobs, this value is the minute past the hour at which the job runs. It is not used for minute jobs.</attribute>
            <attribute name="incl">1,2,3,4,5,6,7,8,9,0</attribute>
          </parameterinfo>
        </parameter>
        <parameter name="repeat" value="1">
          <attribute name="dis_en">CAF Scheduler: Repeat</attribute>
          <parameterinfo name="pi_repeat">
          <attribute name="type">int</attribute>
          <attribute name="desc">The time between repetitions of the job. This depends on the type - e.g. for a daily job, this is the number of days between jobs.</attribute>
          <attribute name="incl">1,2,3,4,5,6,7,8,9,0</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="randomnowtime" value="0">
          <attribute name="dis_en">CAF Scheduler: Random now time</attribute>
          <parameterinfo name="pi_randomnowtime">
            <attribute name="type">int</attribute>
            <attribute name="desc">If "now" is specified in the type then this is the number of seconds within which the job runs.</attribute>
            <attribute name="incl">1,2,3,4,5,6,7,8,9,0</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="randomminutes" value="10">
          <attribute name="dis_en">CAF Scheduler: Random minutes</attribute>
          <parameterinfo name="pi_randomminutes">
            <attribute name="type">int</attribute>
            <attribute name="desc">If "random" is specified in the job type then a random number of minutes between 0 and this value is added to the specified job time. This allows a job to run at "fuzzy" regular intervals.</attribute>
            <attribute name="incl">1,2,3,4,5,6,7,8,9,0</attribute>
          </parameterinfo>
        </parameter>

        <parameter name="depends" value="amagent">
          <attribute name="dis_en">Plugin dependency</attribute>
          <parameterinfo name="pi_type">
            <attribute name="type">string</attribute>
            <attribute name="desc">Name of plugin required by job</attribute>
          </parameterinfo>
        </parameter>

      </paramsection>

     </paramsection>
    </paramsection>
   </paramsection>
  </paramsection>
 </allusers>
</configuration>

This is an example for execution of another amagent.
This file could be adapted.

Adapt the values in this part :

<configuration>
 <allusers>
  <paramsection name="itrm">
   <paramsection name="common">
    <paramsection name="caf">
     <paramsection name="scheduler">
      
      <paramsection name="amagentschedule2">
        <attribute name="helpid">9000</attribute>
        <attribute name="dis_en">Run the UAM agent 2</attribute>
        
        <parameter name="commandline" value="start amagent">

In this example there is amagentschedule2 and “Run the UAM agent 2”

These values could be modified.

 

2- Execute this command on the DOMAIN (or ENTERPRISE) manager in order to import this configuration in the Default Computer Policy :

ccnfregdb -mlocalhost -fnew_scheduler_task.xml -o -e

The configuration appears in the Default Computer Policy :

 

3- Update or create a configuration policy applied on the agent and set True for Enabled settings for the new task and adjust the others settings with desired values :

 

4- Seal the policy and apply it on the agents.


5- On the Agent, the Scheduled task is created. We could see it in the DSM properties - Common Agent of CAF Systray.

But the description is empty :

In order to avoid empty description, execute this following command on the Agents. This will import the new section in the comstore.

ccnfcmda -cmd Merge -fi new_scheduler_task.xml

This command could be executed via a SD Package

After execution of this command the description field is filled :

Additional Information

A created scheduled task could be deleted. Here is the method to do this :

Delete a scheduled task

Here are the steps to remove a created scheduled task :

1- Create a file remove_scheduler_task.xml with following xml lines :

<configuration>
  <allusers>
    <paramsection path="/itrm/common/caf/scheduler/amagentschedule2" /> 
  </allusers>
</configuration>

Change the name amagentschedule2 with the appropriate name.

2- Execute this command on the DOMAIN (or Enterprise) Manager :

ccnfregdb -mlocalhost -rremove_scheduler_task.xml -o -e

The section disappear in the Default Computer Policy

 

3- On the target machine execute this command in order to remove the section in the comstore :

ccnfcmda -cmd DeleteParamsection -ps itrm/common/caf/scheduler/amagentschedule2 -manager

Remark : Replace amagentschedule2 by the correct section name.

This command could be executed via a AM or SD job.

The scheduled task disappears from caf systray properties