Previous page

Next page

Locate page in Contents

Print this page

taskType

Summary:

Defines a scheduler task.

Type specification:

Name

Min/Max

Type

Description

id

0..1

guid_type

Task ID. The value is initially generated by Agent when the task is added to the scheduler. You will need this ID to perform other task operations, such as removing, listing, or updating the task.

title

1..1

base64Binary

Task title.

description

0..1

base64Binary

Task description.

category

1..1

string

Task category. This parameter is used by Virtuozzo Tools to identify the task category. You may use any value that you like here.

triggers

1..1

 

Schedule policy.

{

 

 

 

trigger

1..1

triggerType

This parameter determines how and when the task will be executed. Use the appropriate subtype of the triggerType depending on the schedule policy type (i,e, daily, weekly, etc.)

}

 

 

 

next_start

0..1

datetime_type

This is a read-only parameter. Do not use it in the add or update calls.

Indicates the date and time of the next firing according to the current schedule.

 

 

 

 

packet

0..1

base64Binary

This is the actual task, a base-64-encoded string containing a valid Agent XML message that will be executed according to the schedule specified in the triggers parameter (above).

disabled

0..1

boolean

Indicates whether the task is disabled or enabled.

true -- the task is disabled.

false or absent -- the task is enabled.

You may use this parameter in the update call to enable or disable an existing task.

Please send us your feedback on this help page