upgradegroup : Upgrade group object.

To minimize the impact of Grid upgrades on system operations, you can organize members into upgrade groups and schedule their software distributions. The upgrade group object provides configuration of upgrade and software distribution for members included in the upgrade group.

Object Reference

References to upgradegroup are object references.

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

  • The upgrade group name
Example:
upgradegroup/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:group1

Restrictions

The object does not support the following operations:

  • 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): comment, name.

The following fields are required to create this object:

Field Notes
name  

comment

comment

The upgrade group descriptive comment.

Type

String.

Create

The default value is empty.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The comment is part of the base object.

distribution_dependent_group

distribution_dependent_group

The distribution dependent group name.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

distribution_policy

distribution_policy

The distribution scheduling policy.

Type

String.

Valid values are:
  • SEQUENTIALLY
  • SIMULTANEOUSLY

Create

The default value is SIMULTANEOUSLY.

Search

The field is not available for search.

distribution_time

distribution_time

The time of the next scheduled distribution.

Type

Timestamp.

Create

The default value is empty.

Search

The field is not available for search.

members

members

The upgrade group members.

Type

A/An Upgrade group member structure struct array.

Create

The default value is:

empty

Search

The field is not available for search.

name

name

The upgrade group name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

time_zone

time_zone

The time zone for scheduling operations.

Type

String.

Valid values are:
  • (UTC + 10:00) Brisbane
  • (UTC + 10:00) Canberra, Sydney
  • (UTC + 10:00) Guam
  • (UTC + 10:00) Hobart
  • (UTC + 10:00) Melbourne, Victoria
  • (UTC + 10:00) Vladivostok
  • (UTC + 11:00) Magadan
  • (UTC + 11:00) Solomon Islands
  • (UTC + 12:00) Anadyr
  • (UTC + 12:00) Auckland
  • (UTC + 12:00) Fiji
  • (UTC + 12:00) Marshall Islands
  • (UTC + 1:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
  • (UTC + 1:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
  • (UTC + 1:00) Brussels, Copenhagen, Madrid, Paris
  • (UTC + 1:00) Casablanca
  • (UTC + 1:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
  • (UTC + 2:00) Athens, Vilnius
  • (UTC + 2:00) Bucharest
  • (UTC + 2:00) Cairo
  • (UTC + 2:00) Harare
  • (UTC + 2:00) Helsinki
  • (UTC + 2:00) Jerusalem
  • (UTC + 2:00) Kaliningrad
  • (UTC + 3:00) Baghdad, Istanbul, Kuwait, Minsk, Riyadh
  • (UTC + 3:00) Moscow, St. Petersburg, Volgograd
  • (UTC + 3:00) Nairobi
  • (UTC + 3:30) Tehran
  • (UTC + 4:00) Baku
  • (UTC + 4:00) Dubai
  • (UTC + 4:00) Samara
  • (UTC + 4:30) Kabul
  • (UTC + 5:00) Ekaterinburg
  • (UTC + 5:00) Islamabad, Karachi
  • (UTC + 5:30) Bombay, Calcutta, Madras, New Delhi
  • (UTC + 5:30) Colombo
  • (UTC + 6:00) Dhaka
  • (UTC + 6:00) Omsk
  • (UTC + 6:30) Rangoon
  • (UTC + 7:00) Bangkok, Hanoi
  • (UTC + 7:00) Krasnoyarsk
  • (UTC + 8:00) Beijing, Chongqing, Shanghai
  • (UTC + 8:00) Hong Kong
  • (UTC + 8:00) Irkutsk
  • (UTC + 8:00) Perth
  • (UTC + 8:00) Singapore
  • (UTC + 8:00) Taipei
  • (UTC + 9:00) Osaka, Sapporo, Tokyo
  • (UTC + 9:00) Seoul
  • (UTC + 9:00) Yakutsk
  • (UTC + 9:30) Adelaide
  • (UTC + 9:30) Darwin
  • (UTC - 10:00) Hawaii
  • (UTC - 11:00) Midway Island, Samoa
  • (UTC - 12:00)
  • (UTC - 1:00) Azores
  • (UTC - 2:00) Mid-Atlantic
  • (UTC - 3:00) Brasilia
  • (UTC - 3:00) Buenos Aires
  • (UTC - 3:30) Newfoundland
  • (UTC - 4:00) Atlantic Time (Canada)
  • (UTC - 4:00) Caracas
  • (UTC - 4:00) Santiago
  • (UTC - 5:00) Bogota, Lima, Quito
  • (UTC - 5:00) Eastern Time (US and Canada)
  • (UTC - 5:00) Indiana (East)
  • (UTC - 6:00) Central Time (US and Canada)
  • (UTC - 6:00) Mexico City, Tegucigalpa
  • (UTC - 6:00) Saskatchewan
  • (UTC - 7:00) Arizona
  • (UTC - 7:00) Mountain Time (US and Canada)
  • (UTC - 8:00) Pacific Time (US and Canada), Tijuana
  • (UTC - 9:00) Alaska
  • (UTC) Coordinated Universal Time
  • (UTC) Dublin
  • (UTC) Lisbon
  • (UTC) London

Search

The field is not available for search.

Notes

The time_zone cannot be updated.

time_zone cannot be written.

upgrade_dependent_group

upgrade_dependent_group

The upgrade dependent group name.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

upgrade_policy

upgrade_policy

The upgrade scheduling policy.

Type

String.

Valid values are:
  • SEQUENTIALLY
  • SIMULTANEOUSLY

Create

The default value is SEQUENTIALLY.

Search

The field is not available for search.

upgrade_time

upgrade_time

The time of the next scheduled upgrade.

Type

Timestamp.

Create

The default value is empty.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
distribution_dependent_group String N N N N/A
distribution_policy String N N N N/A
distribution_time Timestamp N N N N/A
members [struct] N N N N/A
name String Y N Y : = ~
time_zone String N Y N N/A
upgrade_dependent_group String N N N N/A
upgrade_policy String N N N N/A
upgrade_time Timestamp N N N N/A