Difference between revisions of "Recitaladmin"
Yvonnemilne (Talk | contribs) (→help) |
Yvonnemilne (Talk | contribs) |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
Note: recitaladmin must be run as root. For systems with a hidden root account, please precede commands with '''sudo'''. | Note: recitaladmin must be run as root. For systems with a hidden root account, please precede commands with '''sudo'''. | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
===start [ -l | logging ]=== | ===start [ -l | logging ]=== | ||
Start the recital daemon. Logging may optionally be enabled. | Start the recital daemon. Logging may optionally be enabled. | ||
− | < | + | <pre> |
recitaladmin start | recitaladmin start | ||
− | </ | + | </pre> |
===stop=== | ===stop=== | ||
Stop the recital daemon. This will prevent new connections and disconnect existing connections. It has no effect on interactive users. | Stop the recital daemon. This will prevent new connections and disconnect existing connections. It has no effect on interactive users. | ||
− | < | + | <pre> |
recitaladmin stop | recitaladmin stop | ||
− | </ | + | </pre> |
===shutdown [ message ]=== | ===shutdown [ message ]=== | ||
− | Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are | + | Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are disabled. A shutdown message can be sent to interactive users before the shutdown. |
− | < | + | <pre> |
recitaladmin shutdown "Please log out." | recitaladmin shutdown "Please log out." | ||
− | </ | + | </pre> |
===disable=== | ===disable=== | ||
Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users. | Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users. | ||
− | < | + | <pre> |
recitaladmin disable | recitaladmin disable | ||
− | </ | + | </pre> |
NOTE: An ODBC client attempting to connect to a disabled server will receive the following message: | NOTE: An ODBC client attempting to connect to a disabled server will receive the following message: | ||
Line 42: | Line 28: | ||
===enable=== | ===enable=== | ||
Enable the recital daemon and interactive users. This will enable new connections and users | Enable the recital daemon and interactive users. This will enable new connections and users | ||
− | < | + | <pre> |
recitaladmin enable | recitaladmin enable | ||
− | </ | + | </pre> |
===suspend=== | ===suspend=== | ||
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users. | Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users. | ||
− | < | + | <pre> |
recitaladmin suspend | recitaladmin suspend | ||
− | </ | + | </pre> |
===resume=== | ===resume=== | ||
Resume the recital daemon and interactive users. This will resume all suspended connections and users. | Resume the recital daemon and interactive users. This will resume all suspended connections and users. | ||
− | < | + | <pre> |
recitaladmin resume | recitaladmin resume | ||
− | </ | + | </pre> |
===logout [ message ]=== | ===logout [ message ]=== | ||
− | Log out interactive users. A log out message can be sent to interactive users before | + | Log out interactive users. A log out message can be sent to interactive users before they are logged out. |
− | < | + | <pre> |
recitaladmin logout "Please log out for system maintenance." | recitaladmin logout "Please log out for system maintenance." | ||
− | </ | + | </pre> |
+ | |||
+ | ===logoff username === | ||
+ | Log out a specific user. A message is sent to the user before they are logged out. | ||
+ | <pre> | ||
+ | recitaladmin logoff sports | ||
+ | </pre> | ||
===broadcast [ message ]=== | ===broadcast [ message ]=== | ||
Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared. | Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared. | ||
− | < | + | <pre> |
recitaladmin broadcast "Hello everybody." | recitaladmin broadcast "Hello everybody." | ||
− | </ | + | </pre> |
===terminate=== | ===terminate=== | ||
Terminate cleanly the specified recital process. | Terminate cleanly the specified recital process. | ||
− | < | + | <pre> |
recitaladmin terminate 999 | recitaladmin terminate 999 | ||
− | </ | + | </pre> |
+ | |||
===status=== | ===status=== | ||
Display whether the recital daemon is running or not. | Display whether the recital daemon is running or not. | ||
− | < | + | <pre> |
recitaladmin status | recitaladmin status | ||
− | </ | + | </pre> |
===fullstatus=== | ===fullstatus=== | ||
Display whether the recital daemon is running or not, the maximum and current connections and whether logging is enabled or disabled. | Display whether the recital daemon is running or not, the maximum and current connections and whether logging is enabled or disabled. | ||
− | < | + | <pre> |
recitaladmin fullstatus | recitaladmin fullstatus | ||
− | </ | + | </pre> |
===help=== | ===help=== | ||
− | Display | + | Display help information |
<pre> | <pre> | ||
recitaladmin help | recitaladmin help | ||
Line 89: | Line 82: | ||
===version=== | ===version=== | ||
Display product version | Display product version | ||
− | < | + | <pre> |
recitaladmin version | recitaladmin version | ||
− | </ | + | </pre> |
Latest revision as of 15:30, 11 November 2014
Administration management tool used with the Recital software suite. It takes the following arguments.
Note: recitaladmin must be run as root. For systems with a hidden root account, please precede commands with sudo.
Contents
start [ -l | logging ]
Start the recital daemon. Logging may optionally be enabled.
recitaladmin start
stop
Stop the recital daemon. This will prevent new connections and disconnect existing connections. It has no effect on interactive users.
recitaladmin stop
shutdown [ message ]
Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are disabled. A shutdown message can be sent to interactive users before the shutdown.
recitaladmin shutdown "Please log out."
disable
Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users.
recitaladmin disable
NOTE: An ODBC client attempting to connect to a disabled server will receive the following message:
Invalid license: errno(-24)
enable
Enable the recital daemon and interactive users. This will enable new connections and users
recitaladmin enable
suspend
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users.
recitaladmin suspend
resume
Resume the recital daemon and interactive users. This will resume all suspended connections and users.
recitaladmin resume
logout [ message ]
Log out interactive users. A log out message can be sent to interactive users before they are logged out.
recitaladmin logout "Please log out for system maintenance."
logoff username
Log out a specific user. A message is sent to the user before they are logged out.
recitaladmin logoff sports
broadcast [ message ]
Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared.
recitaladmin broadcast "Hello everybody."
terminate
Terminate cleanly the specified recital process.
recitaladmin terminate 999
status
Display whether the recital daemon is running or not.
recitaladmin status
fullstatus
Display whether the recital daemon is running or not, the maximum and current connections and whether logging is enabled or disabled.
recitaladmin fullstatus
help
Display help information
recitaladmin help
version
Display product version
recitaladmin version