LinuxCommandLibrary

nxcdb

Query or administer a NoMachine connection database

TLDR

Enter an interactive database session

$ nxcdb
copy

Display the currently active workspace
$ nxcdb --get-workspace
copy

Create a new workspace
$ nxcdb --create-workspace [workspace_name]
copy

Activate the specified workspace
$ nxcdb --set-workspace [workspace_name]
copy

SYNOPSIS

nxcdb command [options]

PARAMETERS

--add
    Adds a new server entry to the database.

--delete server
    Deletes a server entry from the database, identified by server name.

--list
    Lists all server entries in the database.

--modify server
    Modifies an existing server entry identified by server name.

--help
    Displays help information.

--server server
    Specify the server name.

--address address
    Specify the server address.

--port port
    Specify the server port.

DESCRIPTION

The `nxcdb` command is a command-line tool used to manage the NoMachine client database. This database stores information about NoMachine servers and their associated connection profiles. It allows users to add, remove, list, and modify NoMachine server entries within the client configuration.

It's designed for administrators or advanced users who need to script or automate NoMachine client configuration. The `nxcdb` command provides granular control over the client's connection settings, enabling streamlined management of multiple NoMachine server connections. Usually, standard users manage connections through the NoMachine GUI client.

CAVEATS

The `nxcdb` command interacts directly with the NoMachine client's configuration files. Incorrect usage could potentially corrupt the client's configuration and prevent connections to NoMachine servers. Always back up the NoMachine client configuration before using `nxcdb` for modifications.

EXAMPLES

To add a new server entry:
nxcdb --add --server mynewserver --address 192.168.1.100 --port 22

To list all existing server entries:
nxcdb --list

SEE ALSO

nxplayer(1)

Copied to clipboard