runadmin

java -Xmx64m -Xms64m -jar KVHOME/lib/kvstore.jar runadmin
         -host <hostname> -port <port> | -helper-hosts <host:port[,host:port]*>
         [-store <storeName> ]
         [-username <user>] [-security <security-file-path>]
         [-admin-username <adminUser>]
         [-admin-security <admin-security-file-path>]
         [-timeout <timeout ms>]
         [-consistency <ABSOLUTE(default) | NONE_REQUIRED>]
         [-durability <COMMIT_SYNC(default) | COMMIT_NO_SYNC | COMMIT_WRITE_NO_SYNC>]
         [-dns-cachettl <time in sec>]
         [-registry-open-timeout <time in ms>]
         [-registry-read-timeout <time in ms>]
         [single command and arguments]

The runadmin command starts the Admin command line interface (CLI) utility on the host Storage Node (SN) of your choice. You use the CLI to perform configuration activities for your store.

You can start the CLI on a single host, using the following flags. You can specify any storage node as a single host, including an Admin-only host without any replica nodes:

-host <hostname> -port <port>

To have more than one host support the Admin command line interface, use the -helper-hosts option with two or more hosts:

-helper-hosts <host:port[,host:port]*>

Note: The runadmin-admin-host <adminHost> -admin-port <adminPort> options are deprecated. Entering either option results in an error. If you are using these options in scripts, replace them with either the -host or -helper-hosts options (and their port specifications), as noted in the syntax statement.

Use the -timeout, -consistency, and -durability flags to override the connect configuration settings.

where:

• -timeout

  Specifies the store request time-out in milliseconds. There is no default.

• -consistency

  Specifies the store request consistency. The read operations are serviced either on a master or a replica node depending on the configured value. For more details on consistency, see Consistency Guarantees. The following policies are supported. They are defined in the Consistency class of Java APIs.

  If you do not specify this value, the default value ABSOLUTE is applied for this session.

  • ABSOLUTE - The read operation is serviced on a master node. With ABSOLUTE consistency, you are guaranteed to obtain the latest updated data.

  • NONE-REQUIRED - The read operation can be serviced on a replica node. This implies, that if the data is read from the replica node, it may not match what is on the master. However, eventually, it will be consistent with the master.

  For more details on the policies, see Consistency in the Java Direct Driver API Reference Guide.

• -durability

  Specifies the store request durability. This value defines the durability policies to be applied for achieving master commit synchronization, that is, the actions performed by the master node to return with a normal status from the write operations. For more details on durability, see Durability Guarantees.

  If you do not specify this value, the default value COMMIT_SYNC is applied for this session.

  • COMMIT_NO_SYNC - The data is written to the host’s in-memory cache, but the master node does not wait for the data to be written to the file system’s data buffers or subsequent physical storage.

  • COMMIT_SYNC - The data is written to the in-memory cache, transferred to the file system’s data buffers, and then synchronized to a stable storage before the write operation completes normally.

  • COMMIT_WRITE_NO_SYNC - The data is written to the in-memory cache, and transferred to the file system’s data buffers, but not necessarily into physical storage.

  For more details on the policies, see Durability in the Java Direct Driver API Reference Guide.

• -store: Specifies the name of the store.

• -username <user>

  Specifies a username to log on as in a secure deployment.

• -security <security-file-path>

  In a secured deployment, specifies a path to the security file.

  For example: $KVROOT/security/user.security

• single command and arguments: Specifies the Admin CLI commands that you can use with runadmin command. For details, see Admin CLI Reference.