A.75 edit PeriodicTask

Edits a periodic task.

Syntax

edit PeriodicTask instance [ taskInterval=value ] [ enabled= { Yes | No } ] [ name=value ] [ description=value ]

Where instance is:

{ id=value | name=value }

Description

This command edits the attributes of a periodic task. A periodic task is a task (job) that can be run multiple times, with an interval in between, such as checking server updates repositories for available Oracle VM Server software updates.

Although none of the options are mandatory, you must supply at least one option.

Options

The following table shows the available options for this command.

Option

Description

taskInterval=value

The interval between which the periodic task should run, in minutes. value may be an integer between 1 and 999999999.

enabled= { Yes | No }

Whether to enable the periodic task.

name=value

A name to identify the periodic task.

description=value

Optional description for the periodic task. value is a maximum of 4,000 characters.

To set an empty description, use description="".

{ id=value | name=value }

The instance of the object using either the id or name option, for example name="Server Upgrade Checker Task".

Examples

Example A.97 Disabling a periodic task

OVM> edit PeriodicTask name="Server Upgrade Checker Task" enabled=No

See Also