Difference between revisions of "Recitaladmin"
Yvonnemilne (Talk | contribs) (→logout [ message ]) |
Yvonnemilne (Talk | contribs) |
||
| Line 14: | Line 14: | ||
===--execute filename [ <args> ]=== | ===--execute filename [ <args> ]=== | ||
Execute program file in the background as an agent. Args specified are declared as character variables in the called program. The file name extension defaults to .prg. Only program files that have no user input or display output can be run. | Execute program file in the background as an agent. Args specified are declared as character variables in the called program. The file name extension defaults to .prg. Only program files that have no user input or display output can be run. | ||
| − | < | + | <pre> |
recitaladmin --execute mqagent | recitaladmin --execute mqagent | ||
| − | </ | + | </pre> |
===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 enabled. A shutdown message can be sent to interactive users before the shutdown. | Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are enabled. 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 42: | ||
===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 the they are logged out. | Log out interactive users. A log out message can be sent to interactive users before the they are logged out. | ||
| Line 63: | Line 63: | ||
===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." | ||
</code> | </code> | ||
===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 this information | Display this information | ||
| Line 86: | Line 86: | ||
recitaladmin help | recitaladmin help | ||
</pre> | </pre> | ||
| − | |||
===version=== | ===version=== | ||
Display product version | Display product version | ||
| − | < | + | <pre> |
recitaladmin version | recitaladmin version | ||
| − | </ | + | </pre> |
Revision as of 11:19, 22 January 2010
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
- 1 --server <args>
- 2 --replication <args>
- 3 --integrity <args>
- 4 --convert <args>
- 5 --users [ <args> ]
- 6 --execute filename [ <args> ]
- 7 start [ -l | logging ]
- 8 stop
- 9 shutdown [ message ]
- 10 disable
- 11 enable
- 12 suspend
- 13 resume
- 14 logout [ message ]
- 15 broadcast [ message ]
- 16 status
- 17 fullstatus
- 18 help
- 19 version
--server <args>
Perform administration of the recital server daemon. See recitalserver for full details.
--replication <args>
Perform administration of the recital replication daemon. See recitalreplication for full details.
--integrity <args>
This option is used to verify and if needed, repair Recital data files. See recitalintegrity for full details.
--convert <args>
This option is used to convert data from disparate hardware platforms and databases into and out of Recital Databases. See recitalconvert for full details.
--users [ <args> ]
Perform user administration tasks on Recital. See recitalusers for full details.
--execute filename [ <args> ]
Execute program file in the background as an agent. Args specified are declared as character variables in the called program. The file name extension defaults to .prg. Only program files that have no user input or display output can be run.
recitaladmin --execute mqagent
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 enabled. 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 the they are logged out.
recitaladmin logout "Please log out for system maintenance."
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." </code> ===terminate=== Terminate cleanly the specified recital process. <pre> 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 this information
recitaladmin help
version
Display product version
recitaladmin version
