ARX::Schedule

Introduced : ARX V6.02.000
The Schedule interface allows applications to monitor and manage ARX schedules. CLI References: Schedules.

Methods

Method Description Introduced
create Create a new schedule with default values. CLI References: schedule (gbl). ARX V6.02.000
create_and_configure Create a new schedule and configure it at the same time. CLI References: schedule (gbl). ARX V6.02.000
get_configuration Returns a list of schedule configurations. CLI References: Schedules. ARX V6.02.000
get_list Returns a list of schedule names. CLI References: show policy schedule. ARX V6.02.000
get_status Returns a list of schedule status. CLI References: show policy schedule. ARX V6.02.000
remove Delete a schedule. CLI References: schedule (gbl). ARX V6.02.000
set_description Set the description to a schedule. CLI References: description (gbl-schedule). ARX V6.02.000
set_duration Set the duration to a schedule. CLI References: duration(gbl-schedule). ARX V6.02.000
set_interval Set the interval to a schedule. CLI References: every (gbl-schedule). ARX V6.02.000
set_start Set the start time to a schedule. CLI References: start (gbl-schedule). ARX V6.02.000
set_stop Set the stop time to a schedule. CLI References: stop (gbl-schedule). ARX V6.02.000

Structures

Structure

Description

Configuration

A structure that defines all configuration parameters of a schedule. CLI References: schedule (gbl).

RunTime

A structure that defines one run time status of a schedule. CLI References: show policy schedule.

Status

A structure that defines all status data of a schedule. CLI References: show policy schedule.


Enumerations

Enumeration Description
StatusType Enumeration of ARX schedule status types. CLI References: show policy schedule.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ConfigurationSequence Configuration [] A sequence of Configuration
RunTimeSequence RunTime [] A sequence of RunTime
StatusSequence Status [] A sequence of Status
StatusTypeSequence StatusType [] A sequence of StatusType

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.