Difference between revisions of "Recitaladmin"

From Recital Documentation Wiki
Jump to: navigation, search
(--convert <args>)
(--users [ <args> ])
Line 10: Line 10:
  
  
===--users [ <args> ]===
+
 
Perform user administration tasks on Recital.  See [[recitalusers]] for full details.
+
 
 
===--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.

Revision as of 04:51, 25 June 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.






--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."

logoff username

Log out a specific user. A message is sent to the user before the 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