mastergrid : Master Grid object.¶
This object represents the Master Grid. The Master Grid object is automatically generated when a Grid successfully joins the Master Grid.
Object Reference¶
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
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Permissions
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): address, discovery_sync_disabled, enable, joined, port.
address¶
- address¶
IP Address or FQDN to use to contact the SGM
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
The address is part of the base object.
connection_disabled¶
- connection_disabled¶
Indicates whether the sub-grid is currently disabled (true) or not (false).
Type
Bool.
Create
The default value is undefined.
Search
The field is available for search via
‘=’ (exact equality)
connection_timestamp¶
- connection_timestamp¶
Timestamp of the beginning of the current VPN connection with the SGM.
Type
Timestamp.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The connection_timestamp cannot be updated.
connection_timestamp cannot be written.
detached¶
- detached¶
Indicate detached state of subgrid with MGM.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The detached cannot be updated.
detached cannot be written.
discovery_sync_disabled¶
- discovery_sync_disabled¶
Enable/Disable discovery service.
Type
Bool.
Create
The default value is undefined.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The discovery_sync_disabled is part of the base object.
enable¶
- enable¶
Enable/Disable SuperGrid membership feature
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The enable is part of the base object.
join_status¶
- join_status¶
Gives the overall status of the Super Grid connectivity
Type
String.
- Valid values are:
FAILED
INACTIVE
WARNING
WORKING
Search
The field is available for search via
‘=’ (exact equality)
Notes
The join_status cannot be updated.
join_status cannot be written.
join_token¶
- join_token¶
Sub grid join token value.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The join_token cannot be updated.
join_token cannot be written.
join_token_expiration¶
- join_token_expiration¶
Timestamp when the sub grid join token expires.
Type
Timestamp.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The join_token_expiration cannot be updated.
join_token_expiration cannot be written.
joined¶
- joined¶
Indicates whether the sub-grid is currently joined or not.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The joined is part of the base object.
The joined cannot be updated.
joined cannot be written.
last_event¶
- last_event¶
Last event notified by the Super Grid Master.
Type
String.
- Valid values are:
ATTACH
DETACH
DISABLE
EVICT
MESSAGE
Search
The field is available for search via
‘=’ (exact equality)
Notes
The last_event cannot be updated.
last_event cannot be written.
last_event_details¶
- last_event_details¶
additional details on the event.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The last_event_details cannot be updated.
last_event_details cannot be written.
last_sync_timestamp¶
- last_sync_timestamp¶
Timestamp of the last synchronization with the SGM.
Type
Timestamp.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The last_sync_timestamp cannot be updated.
last_sync_timestamp cannot be written.
mgm_communication_mode¶
- mgm_communication_mode¶
MGM Communication Mode.
Type
String.
- Valid values are:
MODE1
MODE2
Search
The field is available for search via
‘=’ (exact equality)
Notes
The mgm_communication_mode cannot be updated.
mgm_communication_mode cannot be written.
port¶
- port¶
Alternate port number to use when connecting to the VPN endpoint.
Type
Unsigned integer.
Create
The default value is 1194.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The port is part of the base object.
use_mgmt_port¶
- use_mgmt_port¶
Indicates whether to use the management port to connect to the SGM.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The use_mgmt_port cannot be updated.
use_mgmt_port cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
address |
String |
N |
N |
Y |
: = ~ |
connection_disabled |
Bool |
N |
N |
N |
= |
connection_timestamp |
Timestamp |
N |
Y |
N |
= |
detached |
Bool |
N |
Y |
N |
= |
discovery_sync_disabled |
Bool |
N |
N |
Y |
= |
enable |
Bool |
N |
N |
Y |
= |
join_status |
String |
N |
Y |
N |
= |
join_token |
String |
N |
Y |
N |
= |
join_token_expiration |
Timestamp |
N |
Y |
N |
= |
joined |
Bool |
N |
Y |
Y |
= |
last_event |
String |
N |
Y |
N |
= |
last_event_details |
String |
N |
Y |
N |
= |
last_sync_timestamp |
Timestamp |
N |
Y |
N |
= |
mgm_communication_mode |
String |
N |
Y |
N |
= |
port |
Unsigned int |
N |
N |
Y |
= |
use_mgmt_port |
Bool |
N |
Y |
N |
= |
