Launch the HA maintenance console¶
This page explains how to launch the HA maintenance console, access HA command help, and look up node state from its output.
You can run HA commands from any node on your system. From the operating system q prompt, enter the mc command followed by the node name to start a maintenance console on the appropriate node.
kxsctl mc mymaint
Access console help¶
You access console help by means of the `.maint.ha`help` command. The help shows each HA command as well as its various arguments.
q).maint.ha`help
Usage: .maint.ha`command or .maint.ha[`command[;param1[;param2[;param3[;param4]]]]]
Commands:
`help
Displays this command summary
`state;(`<nodes>)
Displays feed state for the specified nodes (or all nodes if none specified)
`nodes;(`<nodes>)
Displays node state for the specified nodes (or all nodes if none specified)
`feeds;(`<feeds>)
Displays feed configuration for the specified feeds (or all feeds if none specified)
`sysstate;(`<feeds>)
Displays system feed state for the specified feeds (or all feeds if none specified)
`procstate;(`<feeds>)
Displays process feed state for the specified feeds (or all feeds if none specified)
`primaries
Displays current primaries for feeds and key processes
`forcesysstate;<feeds>;<nodes>;<modes>
Forces the active mode for the specified feeds and nodes*
About arming¶
Some high-availability commands require "arming" as a safeguard to acknowledge the critical nature of the command being issued. This provides an extra layer of security to guard against casual or accidental use of these commands. As well, some armed commands require user confirmation.
q).maint.arm`ha
Now armed: `ha
The default timeout interval for arming is five minutes. You can adjust this default value in .maint.ARMPER.
q).maint.ARMPER:00:10
Look up node state¶
Any HA command that you enter from the maintenance console that changes the node state prints to screen the current node state and whether or not the change was automatic or manual.
| State | Description |
|---|---|
| 0 (Unknown) | Node is in the process of being added and cannot be started. |
| 02 (Disabled) | Node has been added and is ready to be started via start scripts. It will not start automatically by the application. |
| 03 (Enabled) | Node is active and can be started via start scripts or automatically by the application (systemd file). |
HA New registry node state:
HA node| host user baseport ts state auto
HA ----|-----------------------------------------------------------------------
HA A | kxsa.firstderivatives.com root 20000 2023.05.31D15:45:08.454939115 03 1
HA B | kxsb.firstderivatives.com root 20000 2023.05.31D15:45:08.477922428 03 1
DISC Discovery changes, scs=`maint`rt deleted=`rt/sub1`rt/sub2
You can also look up the same node state from the command line with kxsctl show nodeState.
The auto column indicates whether the last update was either automatic (1) or user initiated (0). For example, there was an automatic change in state for node A caused by a disk failure on A.