Difference between revisions of "Admin Resource Kit"

From Scalix Wiki
Jump to: navigation, search
(Disk performance test)
(Creating rules for users with sxaa)
 
(27 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 
[[Scalix Wiki]] -> '''Admin Resource Kit'''
 
[[Scalix Wiki]] -> '''Admin Resource Kit'''
  
== Basic monitoring of Scalix with ommaint ==
+
== Basic monitoring of Scalix with sxmaint ==
  
Use the '''ommaint''' script to do basic monitoring of the Scalix environment. The script is typically run as a cron from the crontab. Contained within the comments (at the top) of file are three lines that may be pasted directly into /etc/crontab. Typically the script is placed in the /usr/local/bin directory. Dont forget to give "chmod +x ommaint" before executing it. By default the script will send notifications (by mail) to root. However, if you would like to have them sent other sources, update the MAIL_REPORTS variable in the script.  
+
Use the '''sxmaint''' script to do basic monitoring of the Scalix environment. The script is typically run as a cron from the crontab. Contained within the comments (at the top) of file are three lines that may be pasted directly into /etc/crontab. Typically the script is placed in the /usr/local/bin directory.  
 +
By default the script will send notifications (by mail) to root. However, if you would like to have them sent to other sources, update the MAIL_REPORTS variable in the script .
  
http://downloads.scalix.com/ark/ommaint
+
* '''NOTE:''' Earlier to the release of Scalix 11.3 '''<code>sxmaint</code>''' was superceded by '''<code>ommaint</code>'''.  
 +
 
 +
Please refer to '''<code>man sxmaint</code>''' for usage guidelines and configuration options.
  
 
== Backing up Scalix with sxbackup ==
 
== Backing up Scalix with sxbackup ==
Line 17: Line 20:
 
'''sxaa''' allows a system administrator to administer server-based Scalix rules (autoactions) from the command line. This allows administrators to set up simple rules without needing to use a client or know the user's mailbox password. This command should be run as a Scalix administror or, preferably, root.
 
'''sxaa''' allows a system administrator to administer server-based Scalix rules (autoactions) from the command line. This allows administrators to set up simple rules without needing to use a client or know the user's mailbox password. This command should be run as a Scalix administror or, preferably, root.
  
For a full description of '''sxaa''', please see: http://downloads.scalix.com/ark/sxaa.readme
+
For full description of '''sxaa''' and usage guidelines, please see:'''<code>man sxaa</code>'''
 
+
Download '''sxaa''' at: http://downloads.scalix.com/ark/sxaa
+
  
 
== Importing contacts from csv/ldif file ==
 
== Importing contacts from csv/ldif file ==
Line 33: Line 34:
 
'''olkvers''' - http://downloads.scalix.com/ark/olkvers
 
'''olkvers''' - http://downloads.scalix.com/ark/olkvers
  
* '''NOTE:''' '''<code>olkvers</code>''' scrapes the audit files for the most recent Outlook logins for each user.  If your user is using multiple instances of Outlook (i.e., Outlook on more than one host), only the version of the last login will be shown.  This applies to NotifyLink customers as well.  Ideally '''<code>olkvers</code>''' would show all versions found for a particular user.
+
* '''NOTE:''' '''<code>olkvers</code>''' scrapes the audit files for the most recent Outlook logins for each user.  If your user is using multiple instances <span class="plainlinks">[http://www.diamondlinks.net/ <span style="color:black;font-weight:normal; text-decoration:none!important; background:none!important; text-decoration:none;">link building</span>] of Outlook (i.e., Outlook on more than one host), only the version of the last login will be shown.  This applies to NotifyLink customers as well.  Ideally '''<code>olkvers</code>''' would show all versions found for a particular user.
  
 
== Creating a custom address generation rule (flast.example) ==
 
== Creating a custom address generation rule (flast.example) ==
Line 52: Line 53:
  
 
== Update ScalixDB content without user login using sxapiprep.py ==
 
== Update ScalixDB content without user login using sxapiprep.py ==
After a major release upgrade, and after other events that trigger a database schema change, every Scalix Web Access user must log in in order to trigger a ScalixDB update with their mailbox content. For users with very large numbers of messages in their mailbox, this process can take some time (in extreme cases minutes). This database update can be triggered without the users logging in, for example overnight when system load is low by means of the [[PopulatingPlatformDb|sxapiprep]] script.
+
After a major release upgrade, and after other events that trigger a database schema change, every Scalix Web Access user must log in in order to trigger a ScalixDB update with their mailbox content. For users with very large numbers of <span class="plainlinks">[http://wikinstructions.com/ <span style="color:black;font-weight:normal; text-decoration:none!important; background:none!important; text-decoration:none;">Online Instructions</span>] messages in their mailbox, this process can take some time (in extreme cases minutes). This database update can be triggered without the users logging in, for example overnight when system load is low by means of the [[PopulatingPlatformDb|sxapiprep]] script.
 +
 
 +
 
  
== Disk performance test ==
+
== Checking when users last logged in ==
  
This C program will write random small blocks of data to a large file and sync the changes to disk. This simulates the write behaviour of the Scalix server and will help identify if you have problems with your disk.
+
I wrote this script as a 'lastlog' equivalent for Scalix, simply run it without arguments.
  
The results are displayed as
+
If you have an enhancement request feel free to mail me at ben --attt-- redcircleit --dottt-- com.
Test Started
+
Test file: disktest.data
+
File size: 100 Mb
+
Num write: 10000
+
PRO: 0.000      Create file: disktest.data
+
PRO: 0.352      Zero fill
+
PRO: 2.304      Sync data
+
PRO: 0.000      Seek to start
+
PRO: 0.000      Fill write buffer
+
Starting write tests
+
PRO: 19.193    Write tests complete
+
Test complete
+
  
where a smaller number for the write tests is better. The example above shows reasonable performance.
+
Download it here:
  
To build the binary, make sure you have gcc installed. Take the source file and run
+
*http://www.redcircleit.com/public/scripts/sxlastlog.pl.txt
gcc -Wall -o disktest disktest.c
+
Ignore any warnings about formats in the fprintf statements.
+

Latest revision as of 19:21, 3 June 2015

Scalix Wiki -> Admin Resource Kit

Basic monitoring of Scalix with sxmaint

Use the sxmaint script to do basic monitoring of the Scalix environment. The script is typically run as a cron from the crontab. Contained within the comments (at the top) of file are three lines that may be pasted directly into /etc/crontab. Typically the script is placed in the /usr/local/bin directory. By default the script will send notifications (by mail) to root. However, if you would like to have them sent to other sources, update the MAIL_REPORTS variable in the script .

  • NOTE: Earlier to the release of Scalix 11.3 sxmaint was superceded by ommaint.

Please refer to man sxmaint for usage guidelines and configuration options.

Backing up Scalix with sxbackup

Use the sxbackup script to backup the information store on your Scalix server. untar the file and run the setup script to configure for your system.

http://downloads.scalix.com/ark/sxbackup.tgz

Creating rules for users with sxaa

sxaa allows a system administrator to administer server-based Scalix rules (autoactions) from the command line. This allows administrators to set up simple rules without needing to use a client or know the user's mailbox password. This command should be run as a Scalix administror or, preferably, root.

For full description of sxaa and usage guidelines, please see:man sxaa

Importing contacts from csv/ldif file

The import tool provides an HTML front-end to allow end-users to import their contact data into the Scalix server without needing to involve a system administrator.

For a full description of import_contacts, please see: http://downloads.scalix.com/ark/import_contacts.readme

Download import_contacts at: http://downloads.scalix.com/ark/import_contacts.tgz

Displaying Outlook version of users who have connected to the Scalix server

olkvers - http://downloads.scalix.com/ark/olkvers

  • NOTE: olkvers scrapes the audit files for the most recent Outlook logins for each user. If your user is using multiple instances link building of Outlook (i.e., Outlook on more than one host), only the version of the last login will be shown. This applies to NotifyLink customers as well. Ideally olkvers would show all versions found for a particular user.

Creating a custom address generation rule (flast.example)

Use this example for creating a custom address generation rule. In this example, the rule will create an address of consisting of the FIRST INITIAL (f) concatinated with the LAST NAME (last) concatinated with @domain.name

flast.map.example - http://downloads.scalix.com/ark/flast.example

Monitoring Scalix with Nagios

This file documents how to setup Nagios to monitor basic services on the Scalix server.

http://downloads.scalix.com/ark/nagios_in_a_scalix_environment.pdf (last updated 2005)

The above document references scalix-nagios.tar.gz, a tarball of preset Nagios configuration files located here:

(Please note that some of the configuration files will need to be manually updated for Scalix 11.)

Update ScalixDB content without user login using sxapiprep.py

After a major release upgrade, and after other events that trigger a database schema change, every Scalix Web Access user must log in in order to trigger a ScalixDB update with their mailbox content. For users with very large numbers of Online Instructions messages in their mailbox, this process can take some time (in extreme cases minutes). This database update can be triggered without the users logging in, for example overnight when system load is low by means of the sxapiprep script.


Checking when users last logged in

I wrote this script as a 'lastlog' equivalent for Scalix, simply run it without arguments.

If you have an enhancement request feel free to mail me at ben --attt-- redcircleit --dottt-- com.

Download it here: