# describe-node ## Description Get a property of a node. The following describes the properties of a SingleStore node. | Name | Description | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `memsqlId` | GUID value uniquely identifying this node. | | `host` | The host on which the node resides. | | `role` | Role of the node in thecluster. Valid values are`Master`,`Aggregator`(for child aggregators),`Leaf`, and`Unknown`. | | `port` | Port number that this node is listening on. | | `bindAddress` | The IP address that the node is listening on. A value of`0.0.0.0`means the node is listening on all available network interfaces on the host. | | `allowIpv6` | Whether to enable IPv6 support. If set to`false`,SingleStorecan only use an IPv4 network. If set to`true`,SingleStorecan use either an IPv4 or IPv6 network. | | `processState` | Current state of`memsqld`for this node. Valid values are`Running`,`Stopped`, and`Unknown`. | | `version` | Version ofSingleStorefor this node. | | `memsqlConfig` | Absolute path of the`memsql.cnf`configuration file forSingleStorefor this node.Defined in the`defaults_file`engine variable.Refer to[SingleStore Node Config Files](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/cluster-config-files/singlestore-node-config-files.md)for more information. | | `dataDir` | Directory path for the data directory. This directory contains snapshots, logs, and columnstore segments. | | `plancacheDir` | Directory path for the plancache directory. This directory contains compiled plans used for codegen.Default value:`./plancache` | | `tracelogsDir` | Directory path for the tracelogs directory. This directory contains log files, including memsql.log and the query log.Default value:`./tracelogs` | | `auditlogsDir` | Specifies the local or network directory to write log files.For more information on this variable, see[Configure Audit Logging](https://docs.singlestore.com/db/v9.1/security/audit-logging/configuring-audit-logging.md).Default value:`//auditlogs` | | `memsqld` | Absolute path of`memsqld`for this node. | | `nodeID` | A unique identifier used to distinguish each node. Not to be confused with`memsqlId`. | | `pid` | Process ID for the`memsqld_safe`process corresponding to this node. | | `dpid` | Process ID for the`memsqld`process corresponding to this node. | | `autoRestartEnabled` | Indicates whether a node is configured to restart automatically if it should stop unexpectedly. If this value is set to`true`, the node will attempt to restart after a failure. | | `isConnectable` | Specifies if`memsqlctl`can connect to the node. | | `recoveryState` | An enum describing whether or not the node’s databases are recovering. Values are`Online`,`Recovering`, and`RecoveryFailed`. | | `availabilityGroup` | Availability group that the leaf node belongs to for high availability. | | `aggregatorRole` | 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 default ``` ## Remarks 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. For example the SingleStore (MemSQL) ID is listed, which is used in many other `sdb-admin` commands. We can also see this information was collected for the master aggregator node, because the role indicates: `Master`. Additionally the config, data, plancache, logs, and the binary are all at their default paths, which includes a node-specific hash. If you are using a config management system then you might need to customize these paths. They can be configured either as [engine variables](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/engine-variables/list-of-engine-variables.md), or in the [memsqlctl config](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/cluster-config-files/singlestore-server-config-files.md) and [memsqlctl state](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/cluster-config-files/singlestore-node-config-files.md) files. ```shell sdb-admin describe-node --memsql-id 0203BA8679 ``` ```output +--------------------+------------------------------------------------------------------------------------+ | 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' | +--------------------+------------------------------------------------------------------------------------+ ``` *** Modified at: August 22, 2024 Source: [/db/v9.1/reference/singlestore-tools-reference/sdb-admin-commands/describe-node/](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference/sdb-admin-commands/describe-node/) (An index of the documentation is available at /llms.txt)