Parent class—Schedule Base

Manages the schedule for Discovery jobs. Works in conjunction with other object classes, such as Parent class—Discovery Statistics.

  • Class Name: Schedule Base
  • Inheritance: None
Schedule Base Attributes

Attribute

Description

Blackout

UI: Blackout
Required: No

Policy Definable: No Default: NA

An array of UTC times when certificate Discovery does not run. The format is WeekDay:Hour,Hour,...

  • Weekday is 0-6: where zero is Sunday.

  • Hour is 0-23: where zero is midnight. Multiple hours in the same day are comma delimited.

For example, if the blackout period is Saturday between the hours of midnight and 5 AM: 6:0,1,2,3,4,5.

Days Of Month

UI: Day of Month
Required: No

Policy Definable: No Default: NA

An integer value representing a day of the month where the Discovery job may be submitted to a Discovery engine. The Last Day of the Month is indicated by a value of -1. Multiple values of this attribute indicate the Discovery job is allowed to scan on more than one day of the month. The absence of this attribute indicates scans are not restricted to any day(s) of the month.

Days Of Week

UI: Day of Week
Required: No

Policy Definable: No Default: NA

An integer value representing a day of the week where the Discovery job may be submitted to a Discovery engine. 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, and 6 = Saturday.

If a Discovery job scans more than once a week, multiple values of this attribute may be present. The absence of this attribute indicates scans are not restricted to any day(s) of the week.

Days Of Year

UI: Day of Year
Required: No

Policy Definable: No Default: NA

The sum of calendar days to wait before submitting a Discovery job to a placement engine. If it is a leap year, add 1 to the value. For example March 31 is the 100th day of the year. If it is a leap year, the day is the 101st day of the year.

If a Discovery job scans more than once a year, multiple values of this attribute may be present. The absence of this attribute indicates scans are not restricted to any day(s) of the year.

Hour

UI: Time of Day
Required: No

Policy Definable: No. Default: NA

An integer value between 0 and 23 that indicates the hour of the day where the Discovery job may be submitted to a Discovery engine.

Minute

UI: NA
Required: No

Policy Definable: No. Default: NA

An integer value between 0 and 60 that indicates the minute when the Discovery job may be submitted to a Discovery engine.

Priority

UI: Priority
Required: No

Policy Definable: No. Default: 0

A positive integer representing the priority of the Discovery job relative to other jobs when scheduled to run at the same time.

Reschedule

UI: NA
Required: No

Policy Definable: No. Default: 1

1 = Scheduling controls.

Start Now

UI: Run Now
Required: No

Policy Definable: No. Default: NA

A value of 1 indicates the scheduled item should start running as soon as a capable engine is available to work on it.

Start Time

UI: Hourly but only between
Required: No

Policy Definable: No. Default: NA

The earliest time of day where the Discovery job may be submitted to a Discovery engine, expressed in 12‑hour format (AM/PM).

Stop Time

UI: Hourly but only between
Required: No

Policy Definable: No. Default: NA

The latest time of day where the Discovery job may be submitted to a Discovery engine, expressed in 12-hour format (AM/PM).

Timezone

UI: Time Zone
Required: No

Policy Definable: No. Default: NA

The time zone where the Discovery job may be submitted to a Discovery engine.

UTC

UI: NA
Required: No

Policy Definable: No. Default: NA

The exact date and time where the Discovery job begins.

0 = The date and time are based on the time zone of the Trust Protection Platform server.

1 = The date and time are based on the Coordinated Universal Time (UTC).