describe-node
Description
Get a property of a node on the host.
The following describes the properties of a SingleStoreDB node.
Name | Description |
---|---|
memsqlId | GUID value uniquely identifying this node. |
role | Role of the node in the cluster. Valid values are |
port | Port number that this node is listening on. |
bindAddress | The IP address that the node is listening on. A value of |
processState | Current state of |
version | Version of SingleStoreDB for this node. |
memsqlConfig | Absolute path of the |
dataDir | Absolute path of the |
plancacheDir | Absolute path of the |
tracelogsDir | Absolute path of the |
auditlogsDir | Absolute path of the |
memsqld | Absolute path of |
pid | Process ID for the |
dpid | Process ID for the |
isConnectable | Specifies if |
recoveryState | An enum describing whether or not the node’s databases are recovering. Values are |
availabilityGroup | Availability group that the node belongs to. |
Usage
Usage:
memsqlctl describe-node [flags]
Flags:
-h, --help Help for describe-node
--memsql-id string 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:
-c, --config FILE_PATH Path to the memsqctl config file
--default-install-dir DIRECTORY_PATH Path to the default install directory
--insecure-ssl Fall back to insecure SSL connections to local SingleStoreDB nodes if memsqlctl is unable to otherwise establish a connection (ADVANCED)
-j, --json Print output in JSON format
--node-metadata-file FILE_PATH Path to the node metadata file
--parallelism POSITIVE_INTEGER Maximum amount of operations to be run in parallel
--ssl-ca FILE_PATH The path to the CA certificate file (in PEM format) to authenticate the database certificate
--timeout duration Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
--verbose-json Print output in JSON format, include some warnings and user messages
-v, --verbosity count Increase logging verbosity
-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default
Remarks
This command is interactive unless you pass in a value for
--memsql-id
and enable non-interactive mode through the flag--yes
.The
memsqlctl describe-node
command is equivalent to the sdb-admin describe-node command.
Output
The following is the standard output for the describe-node
command.
sudo memsqlctl describe-node **** +-------+------------+------------+------+---------------+---------+ | Index | MemSQL ID | Role | Port | Process State | Version | +-------+------------+------------+------+---------------+---------+ | 1 | 994274A024 | Leaf | 3307 | Running | 6.5.10 | | 2 | E289BBDF58 | Aggregator | 3306 | Running | 6.5.10 | +-------+------------+------------+------+---------------+---------+ Select an option: 2 +-------------------+-----------------------------------------------------------------+ | memsqlId | E289BBDF587D96F323CFDBC190DA5A602C170E0A | | role | Aggregator | | port | 3306 | | bindAddress | 0.0.0.0 | | processState | Running | | version | 6.5.10 | | memsqlConfig | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/memsql.cnf | | dataDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/data | | plancacheDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/plancache | | tracelogsDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/tracelogs | | auditlogsDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/auditlogs | | memsqld | /opt/singlestoredb-server-7.3.10_6c220bccfc/memsqld | | pid | 5745 | | dpid | 5751 | | isConnectable | true | | recoveryState | Online | | availabilityGroup | -- | +-------------------+-----------------------------------------------------------------+
This example retrieves a single property value as JSON.
sudo memsqlctl describe-node --property "processState" --json **** { "processState": "Running" }