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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
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
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The name is part of the base object.
time_zone¶
- time_zone¶
The time zone for scheduling operations.
Type
String.
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 |
