upgradeschedule : Upgrade schedule object.

You can schedule lite and full upgrades for certain NIOS versions. When you schedule an upgrade, you schedule the upgrade for the Grid Master and the upgrade groups, including the Default group. The Grid Master must always upgrade before the upgrade groups.

The upgrade schedule object provides configuration of the scheduled upgrade, activation of the latest upgrade, as well as date and time settings for the upgrade.

Object Reference

References to upgradeschedule are object references.

The name part of the upgrade group schedule object reference has the following components:

  • The ‘upgrade’ string

Example:

upgradeschedule/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:upgrade

Restrictions

The object does not support the following operations:

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): active, start_time, time_zone.

active

active

Determines whether the upgrade schedule is active.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The active is part of the base object.

start_time

start_time

The start time of the upgrade.

Type

Timestamp.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The start_time is part of the base object.

time_zone

time_zone

The time zone for upgrade start time.

Type

String.

Search

The field is not available for search.

Notes

The time_zone is part of the base object.

The time_zone cannot be updated.

time_zone cannot be written.

upgrade_groups

upgrade_groups

The upgrade groups scheduling settings.

Type

A/An Upgrade schedule group structure struct array.

Create

The default value is undefined.

Search

The field is not available for search.

Fields List

Field

Type

Req

R/O

Base

Search

active

Bool

N

N

Y

N/A

start_time

Timestamp

N

N

Y

N/A

time_zone

String

N

Y

Y

N/A

upgrade_groups

[struct]

N

N

N

N/A