The Grid Service Restart Group object provides the following information about the restart: applicable services, members, restart order, and periodicity.
References to grid:servicerestart:group are object references.
The name part of the Service Restart Group object reference has the following components:
- Name of the Service Restart Group
Example: grid:servicerestart:group/ZG5zLmJpbmRfY25h:restartgroup1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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, service.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name | |
| service |
Comment for the Restart Group; maximum 256 characters.
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 available for search via
Notes
The comment is part of the base object.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
Determines if this Restart Group is the default group.
Type
Bool.
Search
The field is available for search via
Notes
The is_default cannot be updated.
is_default cannot be written.
The timestamp when the status of the latest request has changed.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_updated_time cannot be updated.
last_updated_time cannot be written.
The list of members belonging to the group.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The default restart method for this Restart Group.
Type
String.
Create
The default value is SIMULTANEOUS.
Search
The field is not available for search.
The name of this Restart Group.
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
Notes
The name is part of the base object.
The order to restart.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The position cannot be updated.
position cannot be written.
The recurring schedule for restart of a group.
Type
A/An Restart Group Schedule struct.
Create
The default value is See the Restart Group Schedule Setting struct for default values.
Search
The field is not available for search.
The list of requests associated with a restart group.
Type
A/An grid:servicerestart:request object array.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The requests cannot be updated.
requests cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| comment | String | N | N | Y | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| is_default | Bool | N | Y | N | = |
| last_updated_time | Timestamp | N | Y | N | N/A |
| members | [String] | N | N | N | N/A |
| mode | String | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| position | Unsigned int | N | Y | N | N/A |
| recurring_schedule | struct | N | N | N | N/A |
| requests | [obj] | N | Y | N | N/A |
| service | String | Y | N | Y | = |
| status | String | N | Y | N | N/A |
