scheduledtask : Scheduled Task object.¶
This object represents a scheduled task.
Object Reference¶
References to scheduledtask are object references. The name part of a scheduled task object reference has the following components:
The Task ID of the task
Execution status of the task
Example: scheduledtask/ZG5zLm5ldHdvcmtfdmlldyQxMTk:12/PENDING
Restrictions¶
The object does not support the following operations:
Create (insert)
Permissions
Global search (searches via the search object)
Scheduling
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): approval_status, execution_status, task_id.
approval_status¶
- approval_status¶
The approval status of the task.
Type
String.
- Valid values are:
APPROVED
NONE
PENDING
REJECTED
Create
The default value is empty.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The approval_status is part of the base object.
approver¶
- approver¶
The approver of the task.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The approver cannot be updated.
approver cannot be written.
approver_comment¶
- approver_comment¶
The comment specified by the approver of the task.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
automatic_restart¶
- automatic_restart¶
Indicates whether there will be an automatic restart when the appliance executes the task.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
changed_objects¶
- changed_objects¶
A list of objects that are affected by the task.
Type
A/An Changed object information struct array.
Search
The field is not available for search.
Notes
The changed_objects cannot be updated.
changed_objects cannot be written.
dependent_tasks¶
- dependent_tasks¶
If this scheduled task has dependent tasks, their references will be returned in this field.
Type
A/An scheduledtask object array.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The dependent_tasks cannot be updated.
dependent_tasks cannot be written.
execute_now¶
- execute_now¶
If this field is set to True the specified task will be executed immediately.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
execute_now is not readable.
execution_details¶
- execution_details¶
Messages generated by the execution of the scheduled task after its completion.
Type
String array.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The execution_details cannot be updated.
execution_details cannot be written.
execution_details_type¶
- execution_details_type¶
The type of details generated by the execution of the scheduled task after its completion.
Type
String.
- Valid values are:
NONE
WARNING
Search
The field is not available for search.
Notes
The execution_details_type cannot be updated.
execution_details_type cannot be written.
execution_status¶
- execution_status¶
The execution status of the task.
Type
String.
- Valid values are:
COMPLETED
FAILED
PENDING
WAITING_EXECUTION
Search
The field is available for search via
‘=’ (exact equality)
Notes
The execution_status is part of the base object.
The execution_status cannot be updated.
execution_status cannot be written.
execution_time¶
- execution_time¶
The time when the appliance executed the task.
Type
Timestamp.
Search
The field is available for search via
‘<=’ (less than search)
‘>=’ (greater than search)
‘=’ (exact equality)
Notes
The execution_time cannot be updated.
execution_time cannot be written.
is_network_insight_task¶
- is_network_insight_task¶
Indicates whether this is a Network Insight scheduled task.
Type
Bool.
Search
The field is not available for search.
Notes
The is_network_insight_task cannot be updated.
is_network_insight_task cannot be written.
member¶
- member¶
The member where this task was created.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The member cannot be updated.
member cannot be written.
predecessor_task¶
- predecessor_task¶
If this scheduled task has a predecessor task set, its reference will be returned in this field.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The predecessor_task cannot be updated.
predecessor_task cannot be written.
re_execute_task¶
- re_execute_task¶
If set to True, if the scheduled task is a Network Insight task and it failed, a new task will be cloned from this task and re-executed.
Type
Bool.
Create
The default value is empty.
Search
The field is not available for search.
scheduled_time¶
- scheduled_time¶
The time when the task is scheduled to occur.
Type
Timestamp.
Create
The default value is The scheduled time.
Search
The field is available for search via
‘<=’ (less than search)
‘>=’ (greater than search)
‘=’ (exact equality)
submit_time¶
- submit_time¶
The time when the task was submitted.
Type
Timestamp.
Search
The field is available for search via
‘<=’ (less than search)
‘>=’ (greater than search)
‘=’ (exact equality)
Notes
The submit_time cannot be updated.
submit_time cannot be written.
submitter¶
- submitter¶
The submitter of the task.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The submitter cannot be updated.
submitter cannot be written.
submitter_comment¶
- submitter_comment¶
The comment specified by the submitter of the task.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
task_id¶
- task_id¶
The task ID.
Type
Unsigned integer.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The task_id is part of the base object.
The task_id cannot be updated.
task_id cannot be written.
task_type¶
- task_type¶
The task type.
Type
String.
- Valid values are:
OBJECT_CHANGE
PORT_CONTROL
Search
The field is not available for search.
Notes
The task_type cannot be updated.
task_type cannot be written.
ticket_number¶
- ticket_number¶
The task ticket number.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The ticket_number cannot be updated.
ticket_number cannot be written.
Search-only Fields¶
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
changed_objects.action¶
- changed_objects.action¶
The action to search for, valid values are:
Convert IPv4 Lease
Delete
Restart Services
Add
Convert IPv6 Lease
Lock/Unlock Zone
Reset Grid
Configure Grid
Restart Services
Network Discovery
Upgrade Grid
Modify
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
changed_objects.action is a search-only field.
changed_objects.name¶
- changed_objects.name¶
The name of the changed object
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
changed_objects.name is a search-only field.
changed_objects.object_type¶
- changed_objects.object_type¶
The WAPI object type of the specified object.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
changed_objects.object_type is a search-only field.
changed_objects.type¶
- changed_objects.type¶
The object type. Following are samples of valid type values:
A Record
AAAA Record
Authoritative Zone
Bulk Host
CNAME Record
Delegated Zone
DHCP Range
DNAME Record
DNS View
Fixed Address
Forward Zone
Host Record
IPv4 Network
IPv4 Network Container
IPv6 Network
IPv6 Network Container
MX Record
NS Record
PTR Record
Reservation
Roaming Host
Shared A Record
Shared AAAA Record
Shared MX Record
Shared Network
Shared Record Group
Shared SRV Record
Shared TXT Record
SRV Record
Stub Zone
TXT Record
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
changed_objects.type is a search-only field.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
approval_status |
String |
N |
N |
Y |
= |
approver |
String |
N |
Y |
N |
: = ~ |
approver_comment |
String |
N |
N |
N |
N/A |
automatic_restart |
Bool |
N |
N |
N |
N/A |
changed_objects |
[struct] |
N |
Y |
N |
N/A |
dependent_tasks |
[obj] |
N |
Y |
N |
N/A |
execute_now |
Bool |
N |
N |
N |
N/A |
execution_details |
[String] |
N |
Y |
N |
N/A |
execution_details_type |
String |
N |
Y |
N |
N/A |
execution_status |
String |
N |
Y |
Y |
= |
execution_time |
Timestamp |
N |
Y |
N |
< = > |
is_network_insight_task |
Bool |
N |
Y |
N |
N/A |
member |
String |
N |
Y |
N |
= |
predecessor_task |
String |
N |
Y |
N |
N/A |
re_execute_task |
Bool |
N |
N |
N |
N/A |
scheduled_time |
Timestamp |
N |
N |
N |
< = > |
submit_time |
Timestamp |
N |
Y |
N |
< = > |
submitter |
String |
N |
Y |
N |
: = ~ |
submitter_comment |
String |
N |
N |
N |
N/A |
task_id |
Unsigned int |
N |
Y |
Y |
= |
task_type |
String |
N |
Y |
N |
N/A |
ticket_number |
String |
N |
Y |
N |
N/A |
Search-only Fields List¶
Field |
Type |
Search |
|---|---|---|
changed_objects.action |
String |
= |
changed_objects.name |
String |
: = ~ |
changed_objects.object_type |
String |
= |
changed_objects.type |
String |
: = ~ |
