Loading...

XML Parameters for Schedule and Schedule Policy Operations

The following table lists the supported parameters for schedule and schedule policy operations. Not all parameters apply to all operations. Refer to the XML template files to see the parameters supported for your operation.

Parameter

Description and Parameter Values

task/taskName

The name of the schedule policy.

taskType

The task type must be set to SCHEDULE_POLICY.

taskOperation

The task operation must be set to MODIFY.

clientGroupName

Name of the client computer group.

clientName

Name of the client computer.

appName

Name of the agent. For example, "File System" for the Windows or the Unix File System agent.

Tip: For a list of valid values, see GET Agent: appName.

instanceName

Name of the instance.

backupsetName

Name of the backup set. If the backup set name is not specified in the command query, the default backup set is used by default.

subclientName

Name of the subclient.

include

Adds an entity association to a schedule policy. This parameter cannot be used with the deleted and exclude parameters in the same <associations> block. Add additional <associations> blocks to use the deleted and exclude parameters with the include parameter:

<associations>
  <clientName>client001</clientName>
  <flags>
    <include>1</include>
    <deleted>0</deleted>
    <exclude>0</exclude>
  </flags>
</associations>
<associations>
  <clientName>client087</clientName>
  <flags>
    <include>0</include>
    <deleted>1</deleted>
    <exclude>0</exclude>
  </flags>
<associations>
  <clientName>client087</clientName>
  <appName>File System</appName>
  <backupsetName>backupset009</backupsetName>
  <subclientName>default</subclientName>
  <flags>
    <include>0</include>
    <deleted>0</deleted>
    <exclude>1</exclude>
  </flags>
</associations>

Valid values:

  • 1, true
  • 0, false

deleted

Deletes an entity association from a schedule policy. This parameter cannot be used with the include and exclude parameters in the same <associations> block. Add additional <associations> blocks to use the include and exclude parameters with the deleted parameter. See the include parameter for an example.

Valid values:

  • 1, true
  • 0, false

exclude

Excludes an entity from a schedule policy association. This parameter cannot be used with the include and deleted parameters in the same <associations> block. Add additional <associations> blocks to use the include and deleted parameters with the exclude parameter. See the include parameter for an example.

Valid values:

  • 1, true
  • 0, false

Filter Parameters

You can set filters in the schedule XML files to display specific schedules or schedule policies. The schedules, isCalendar and policy filters are provided by default. To add additional filters, add the parameter as an attribute in the <filter> element:

<filter schedules="1" isCalendar="0" policy="1" savedReports="1">

Parameter

Description

automaticSchedules

Filter to display only automatic schedules.

Valid values:

  • 1, true
  • 0, false

EZPolicyFilter

Filter to display only EZ schedules.

Valid values:

  • 1, true
  • 0, false

isCalendar

Filter to display the schedule details in calendar view.

Valid values:

  • 1, true
  • 0, false

otherReports

Filter to display report schedules.

Valid values:

  • 1, true
  • 0, false

policy

Filter to display schedule policy associations.

Valid values:

  • 1, true
  • 0, false

savedReports

Filter to display only schedules from saved reports.

Valid values:

  • 1, true
  • 0, false

schedules

Filter to display schedule associations.

Valid values:

  • 1, true
  • 0, false

Last modified: 2/27/2018 9:59:34 PM