grid:servicerestart:request : Restart Request object.

The Restart Request object provides information and statistics about the service restart routine for the Service Restart Group.

Object Reference

References to grid:servicerestart:request are object references.

The name part of the name server request object reference has the following components:

  • Name of the member to restart

Example: grid:servicerestart:request/ZG5zLmJpbmRfY25h:infoblox.com

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • 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): error, group, result, state.

error

error

The error message if restart has failed.

Type

String.

Search

The field is not available for search.

Notes

The error is part of the base object.

The error cannot be updated.

error cannot be written.

forced

forced

Indicates if this is a force restart.

Type

Bool.

Search

The field is not available for search.

Notes

The forced cannot be updated.

forced cannot be written.

group

group

The name of the Restart Group associated with the request.

Type

String.

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

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The group is part of the base object.

The group cannot be updated.

group cannot be written.

last_updated_time

last_updated_time

The timestamp when the status of the 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.

member

member

The member to restart.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The member cannot be updated.

member cannot be written.

needed

needed

Indicates if restart is needed.

Type

String.

Valid values are:
  • CHECKING
  • FAILURE
  • NO
  • UNKNOWN
  • YES

Search

The field is not available for search.

Notes

The needed cannot be updated.

needed cannot be written.

order

order

The order to restart.

Type

Integer.

Search

The field is not available for search.

Notes

The order cannot be updated.

order cannot be written.

result

result

The result of the restart operation.

Type

String.

Valid values are:
  • FAILURE
  • NORESTART
  • SUCCESS
  • TIMEOUT

Search

The field is not available for search.

Notes

The result is part of the base object.

The result cannot be updated.

result cannot be written.

service

service

The service to restart.

Type

String.

Valid values are:
  • DHCPV4
  • DHCPV6
  • DNS

Search

The field is not available for search.

Notes

The service cannot be updated.

service cannot be written.

state

state

The state of the request.

Type

String.

Valid values are:
  • FINISHED
  • NEW
  • PROCESSING
  • QUEUED

Search

The field is not available for search.

Notes

The state is part of the base object.

The state cannot be updated.

state cannot be written.

Fields List

Field Type Req R/O Base Search
error String N Y Y N/A
forced Bool N Y N N/A
group String N Y Y =
last_updated_time Timestamp N Y N N/A
member String N Y N =
needed String N Y N N/A
order Integer N Y N N/A
result String N Y Y N/A
service String N Y N N/A
state String N Y Y N/A