describe-node
Warning
SingleStore 9.0 gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.
On this page
Description
Get a property of a node.
The following describes the properties of a SingleStore node.
|
Name |
Description |
|---|---|
|
|
GUID value uniquely identifying this node. |
|
|
The host on which the node resides. |
|
|
Role of the node in the cluster. |
|
|
Port number that this node is listening on. |
|
|
The IP address that the node is listening on. |
|
|
Whether to enable IPv6 support. |
|
|
Current state of |
|
|
Version of SingleStore for this node. |
|
|
Absolute path of the Defined in the Refer to SingleStore Node Config Files for more information. |
|
|
Directory path for the data directory. |
|
|
Directory path for the plancache directory. Default value: |
|
|
Directory path for the tracelogs directory. Default value: |
|
|
Specifies the local or network directory to write log files. Default value: |
|
|
Absolute path of |
|
|
A unique identifier used to distinguish each node. |
|
|
Process ID for the |
|
|
Process ID for the |
|
|
Indicates whether a node is configured to restart automatically if it should stop unexpectedly. |
|
|
Specifies if |
|
|
An enum describing whether or not the node’s databases are recovering. |
|
|
Availability group that the leaf node belongs to for high availability. |
|
|
The role assigned to an aggregator node within the cluster. |
Usage
Usage:
sdb-admin describe-node [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
-a, --all Describe all nodes in the cluster
-h, --help Help for describe-node
--memsql-id MemsqlID The node ID of the node to describe
--property {MemsqlID, Role, AggregatorRole, ProcessState, Version, Memsqld, MemsqlConfig,
Port, BindAddress, AllowIpv6, Datadir, Tracelogsdir, Plancachedir, Auditlogsdir,
IsConnectable, Pid, DPid, AutoRestartEnabled, RecoveryState, AvailabilityGroup,
Host, NodeID, Config[.${CONFIG_NAME}], Variables[.${VARIABLE_NAME}]}
Only output the value of this property (default Unspecified)
Global Flags:
--backup-cache FILE_PATH File path for the backup cache
--cache-file FILE_PATH File path for the Toolbox node cache
-c, --config FILE_PATH File path for the Toolbox configuration
--disable-colors Disable color output in console, which some terminal sessions/environments may have difficulty with
--disable-spinner Disable the progress spinner, which some terminal sessions/environments may have issues with
-j, --json Enable JSON output
--parallelism POSITIVE_INTEGER Maximum number of operations to run in parallel
--runtime-dir DIRECTORY_PATH Where to store Toolbox runtime data
--ssh-control-persist SECONDS Enable SSH ControlPersist and set it to the specified duration in seconds
--ssh-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3
--ssh-strict-host-key-checking Enable strict host key checking for SSH connections
--ssh-user-known-hosts-file FILE_PATH Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
--state-file FILE_PATH Toolbox state file path
-v, --verbosity count Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by defaultRemarks
This command is interactive unless you use either --yes or --json flag to override interactive behavior.
Output
In the example output below you can see the types of information this command returns.sdb-admin commands.Master.
Additionally the config, data, plancache, logs, and the binary are all at their default paths, which includes a node-specific hash.
sdb-admin describe-node --memsql-id 0203BA8679
+--------------------+------------------------------------------------------------------------------------+
| memsqlId | 0203BA86790EE0155CA6DC29B2C827FC936E53A9 |
| host | node1 |
| role | Leaf |
| port | 3308 |
| bindAddress | 0.0.0.0 |
| processState | Running |
| version | 7.3.10 |
| memsqlConfig | /var/lib/memsql/a3e6b7e2-adb0-4b22-ba24-2162f7c33f5a/memsql.cnf |
| datadir | /var/lib/memsql/a3e6b7e2-adb0-4b22-ba24-2162f7c33f5a/data |
| plancachedir | /var/lib/memsql/a3e6b7e2-adb0-4b22-ba24-2162f7c33f5a/plancache |
| tracelogsdir | /var/lib/memsql/a3e6b7e2-adb0-4b22-ba24-2162f7c33f5a/tracelogs |
| auditlogsdir | /var/lib/memsql/a3e6b7e2-adb0-4b22-ba24-2162f7c33f5a/auditlogs |
| memsqld | /opt/singlestoredb-server-7.3.10_6c220bccfc/memsqld |
| pid | 3407 |
| dpid | 3413 |
| autoRestartEnabled | true |
| isConnectable | true |
| recoveryState | Online |
| availabilityGroup | 1 |
| config | Omitted from table view. Use 'sdb-admin describe-node ... --property config' |
| variables | Omitted from table view. Use 'sdb-admin describe-node ... --property variables' |
+--------------------+------------------------------------------------------------------------------------+Last modified: August 22, 2024