This object represents the Master Grid. The Master Grid object is automatically generated when a Grid successfully joins the Master Grid.
References to mastergrid are object references. The name part of a Master Grid object reference has the following components:
- The address of the Master Grid.
Example: mastergrid/ZG5zLm5ldHdvcmtfdmlldyQxMTk:10.0.0.1
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): address, enable, port.
The domain name or IP address for the Master Grid.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The address is part of the base object.
Determines if the sub-grid is currently disabled.
Type
Bool.
Search
The field is not available for search.
Notes
The connection_disabled cannot be updated.
connection_disabled cannot be written.
The timestamp that indicates when the connection to the Master Grid was established.
Type
Timestamp.
Search
The field is not available for search.
Notes
The connection_timestamp cannot be updated.
connection_timestamp cannot be written.
The detached flag for the Master Grid.
Type
Bool.
Search
The field is not available for search.
Notes
The detached cannot be updated.
detached cannot be written.
Determines if the Master Grid is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
The enable is part of the base object.
The flag shows if the Grid has joined the Master Grid.
Type
Bool.
Search
The field is not available for search.
Notes
The joined cannot be updated.
joined cannot be written.
The Master Grid’s last event.
Type
String.
Search
The field is not available for search.
Notes
The last_event cannot be updated.
last_event cannot be written.
The details of the Master Grid’s last event.
Type
String.
Search
The field is not available for search.
Notes
The last_event_details cannot be updated.
last_event_details cannot be written.
The timestamp or the last synchronization operation with the Master Grid.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_sync_timestamp cannot be updated.
last_sync_timestamp cannot be written.
The Master Grid port to which the Grid connects.
Type
Unsigned integer.
Create
The default value is 1194.
Search
The field is available for search via
Notes
The port is part of the base object.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | N | N | Y | : = ~ |
| connection_disabled | Bool | N | Y | N | N/A |
| connection_timestamp | Timestamp | N | Y | N | N/A |
| detached | Bool | N | Y | N | N/A |
| enable | Bool | N | N | Y | N/A |
| joined | Bool | N | Y | N | N/A |
| last_event | String | N | Y | N | N/A |
| last_event_details | String | N | Y | N | N/A |
| last_sync_timestamp | Timestamp | N | Y | N | N/A |
| port | Unsigned int | N | N | Y | = |
| status | String | N | Y | N | N/A |
| use_mgmt_port | Bool | N | Y | N | N/A |
macfilteraddress : MAC Filter Address object.
