Difference between revisions of "Recitaladmin"

From Recital Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
 
Administration management tool used with the Recital software suite. It takes the following arguments.
 
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’.
+
Note: recitaladmin must be run as root. For systems with a hidden root account, please precede commands with ''sudo''.
 
+
 
===--server <args>===
 
===--server <args>===
 
Perform administration of the recital server daemon. See [[recitalserver]] for full details.
 
Perform administration of the recital server daemon. See [[recitalserver]] for full details.
 
 
===--replication <args>===
 
===--replication <args>===
 
Perform administration of the recital replication daemon. See [[recitalreplication]] for full details.
 
Perform administration of the recital replication daemon. See [[recitalreplication]] for full details.
 
 
===--integrity <args>===
 
===--integrity <args>===
 
This  option  is  used  to verify and if needed, repair Recital data files.  See [[recitalintegrity]] for full details.
 
This  option  is  used  to verify and if needed, repair Recital data files.  See [[recitalintegrity]] for full details.
 
 
===--convert <args>===
 
===--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.
 
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> ]===
 
===--users [ <args> ]===
 
Perform user administration tasks on Recital.  See [[recitalusers]] for full details.
 
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.
Line 23: Line 17:
 
  recitaladmin --execute  mqagent
 
  recitaladmin --execute  mqagent
 
</code>
 
</code>
 
 
===start [ -l | logging ]===
 
===start [ -l | logging ]===
 
Start the recital daemon.  Logging may optionally be enabled.  
 
Start the recital daemon.  Logging may optionally be enabled.  
Line 29: Line 22:
 
  recitaladmin start
 
  recitaladmin start
 
</code>
 
</code>
 
 
===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.  
Line 40: Line 32:
 
  recitaladmin shutdown  "Please log out."
 
  recitaladmin shutdown  "Please log out."
 
</code>
 
</code>
 
 
===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.
Line 49: Line 40:
  
 
Invalid license: errno(-24)
 
Invalid license: errno(-24)
 
 
===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
Line 70: Line 60:
 
  recitaladmin  logout  "Please log out for system maintenance."
 
  recitaladmin  logout  "Please log out for system maintenance."
 
</code>
 
</code>
 
 
===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.
Line 76: Line 65:
 
  recitaladmin  broadcast  "Hello everybody."
 
  recitaladmin  broadcast  "Hello everybody."
 
</code>
 
</code>
 
 
===terminate===
 
===terminate===
 
Terminate cleanly the specified recital process.
 
Terminate cleanly the specified recital process.
 
<code lang="bash">
 
<code lang="bash">
 
  recitaladmin  terminate 999
 
  recitaladmin  terminate 999
 +
</code>
 +
===status===
 +
Display whether the recital daemon is running or not.
 +
<code lang="bash">
 +
recitaladmin status
 +
</code>
 +
===fullstatus===
 +
Display whether the recital daemon is running or not, the maximum and current connections and whether logging is enabled or disabled.
 +
<code lang="bash">
 +
recitaladmin fullstatus
 
</code>
 
</code>
 
===help===  
 
===help===  

Revision as of 11:16, 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.

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

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 this information

recitaladmin help

version

Display product version

recitaladmin  version