Difference between revisions of "Recitaladmin"

From Recital Documentation Wiki
Jump to: navigation, search
 
(17 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'''.
−
===--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.
+
−
<code lang="bash">
+
−
recitaladmin --execute  mqagent
+
−
</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.  
−
<code lang="bash">
+
<pre>
 
  recitaladmin start
 
  recitaladmin start
−
</code>
+
</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.  
−
<code lang="bash">
+
<pre>
 
  recitaladmin stop
 
  recitaladmin stop
−
</code>
+
</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 disabled.  A shutdown message can be sent to interactive users before the shutdown.
−
<code lang="bash">
+
<pre>
 
  recitaladmin shutdown  "Please log out."
 
  recitaladmin shutdown  "Please log out."
−
</code>
+
</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.
−
<code lang="bash">
+
<pre>
 
  recitaladmin  disable
 
  recitaladmin  disable
−
</code>
+
</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
−
<code lang="bash">
+
<pre>
 
  recitaladmin  enable
 
  recitaladmin  enable
−
</code>
+
</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.
−
<code lang="bash">
+
<pre>
 
  recitaladmin  suspend
 
  recitaladmin  suspend
−
</code>
+
</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.
−
<code lang="bash">
+
<pre>
 
  recitaladmin resume
 
  recitaladmin resume
−
</code>
+
</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 they are logged out.
−
<code lang="bash">
+
<pre>
−
  recitaladmin logout "Please log out for system maintenance."
+
  recitaladmin logout "Please log out for system maintenance."
−
</code>
+
</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.
−
<code lang="bash">
+
<pre>
 
  recitaladmin  broadcast  "Hello everybody."
 
  recitaladmin  broadcast  "Hello everybody."
−
</code>
+
</pre>
 
===terminate===
 
===terminate===
 
Terminate cleanly the specified recital process.
 
Terminate cleanly the specified recital process.
−
<code lang="bash">
+
<pre>
 
  recitaladmin  terminate 999
 
  recitaladmin  terminate 999
−
</code>
+
</pre>
 +
 
 
===status===  
 
===status===  
 
Display whether the recital daemon is running or not.
 
Display whether the recital daemon is running or not.
−
<code lang="bash">
+
<pre>
 
  recitaladmin status
 
  recitaladmin status
−
</code>
+
</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.
−
<code lang="bash">
+
<pre>
 
  recitaladmin fullstatus
 
  recitaladmin fullstatus
−
</code>
+
</pre>
 
===help===  
 
===help===  
−
Display this information
+
Display help information
−
<code lang="bash">
+
<pre>
 
  recitaladmin help
 
  recitaladmin help
−
</code>
+
</pre>
 +
 
 
===version===
 
===version===
 
Display product version
 
Display product version
−
<code lang="bash">
+
<pre>
 
  recitaladmin  version
 
  recitaladmin  version
−
</code>
+
</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.

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
Retrieved from "https://www.recitalsoftware.com/wiki/index.php?title=Recitaladmin&oldid=16142"