Difference between revisions of "Lazy Admin Tools"

From SME Server
Jump to navigationJump to search
(Create wiki entry based on 2004 LAT documentation)
 
(Text fixes and conformance to other wiki pages)
Line 1: Line 1:
==Installation and Usage of the Lazy Administrator's Tools==
+
===Description===
'''Author:''' Michiel Blotwijk <Michiel.Blotwijk@Altiplano.Be><br>
+
The Lazy Administrator's Tools is a set of scripts designed to automate batch tasks and administration jobs for SME servers. Currently the following tools are available:
'''Release supported:''' SME 5.5/5.6/6.0 (Some functions work in SME 7.x)<br>
+
{{Note box|This HowTo is based on a version in the contribs area by [mailto:Michiel.Blotwijk@Altiplano.Be Michiel Blotwijk]. The latest release was for SME 5.5/5.6/6.0 but some functions work in SME Server version 7.x as well.
'''License:''' GPL<br>
 
'''Last updated:''' 23 January, 2004<br>
 
'''Wiki Entry Created:''' 18 November 2007
 
  
Most Up-todate version can be found here: http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/
+
This version was imported on November 18th, 2007. The original text can be found [http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/ here]}}
  
'''Problem:'''  You have to perform a large number of repetitive admin tasks, which just take too much time to do via the webinterface.
+
===Available functions===
 
 
'''Solution:'''  Let the SME server do it for you :-).
 
 
 
The Lazy Administrator's Tools is a set of scripts designed to automate batch tasks and admin jobs for E-Smith/SME servers. Currently the following tools are available:
 
 
 
===USAGE===
 
 
{|
 
{|
 
!Command
 
!Command
 
!Description
 
!Description
!SME 7 Support
 
 
|-
 
|-
 
| [http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-users.html lat-users]
 
| [http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-users.html lat-users]
 
|add/delete users (and their directories)
 
|add/delete users (and their directories)
 
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-groups.html lat-groups]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-groups.html lat-groups]
 
|add/delete groups
 
|add/delete groups
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-pseudonyms.html lat-pseudonyms]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-pseudonyms.html lat-pseudonyms]
 
|add/delete e-mail pseudonyms for individual users
 
|add/delete e-mail pseudonyms for individual users
|SME 7.x supports '@' in pseudonyms, but '''lat-pseudonym''' does not by default.  See this [http://forums.contribs.org/index.php?topic=37885.msg170809#msg170809 forum post] for a work-around.
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-ibays.html lat-ibays]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-ibays.html lat-ibays]
 
|add/delete ibays (and its directories)
 
|add/delete ibays (and its directories)
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-quota.html lat-quota]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-quota.html lat-quota]
 
|set the disk quota for individual users
 
|set the disk quota for individual users
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-procmail.html lat-procmail]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-procmail.html lat-procmail]
 
|activate or deactivate procmail for individual users
 
|activate or deactivate procmail for individual users
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-hosts.html lat-hosts]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-hosts.html lat-hosts]
 
|add hostnames to the server
 
|add hostnames to the server
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-pptp.html lat-pptp]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-pptp.html lat-pptp]
 
|activate or deactivate pptp access for individualusers
 
|activate or deactivate pptp access for individualusers
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-domains.html lat-domains]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-domains.html lat-domains]
 
|create virtual domains
 
|create virtual domains
|
 
 
|-
 
|-
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-dump.html lat-dump]
 
|[http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/man/lat-dump.html lat-dump]
 
|create input files for the above, using the configuration files of the SME servers.
 
|create input files for the above, using the configuration files of the SME servers.
|
 
 
|-
 
|-
 
|}
 
|}
  
===INSTALLATION===
+
{{Warning box|msg=SME Server 7.x supports the use of '@' in pseudonyms, but '''lat-pseudonym''' does not by default. See this [http://forums.contribs.org/index.php?topic=37885.msg170809#msg170809 forum post] for a work-around.}}
 +
 
 +
===Installation===
 
Download and install using the following commands:
 
Download and install using the following commands:
 
  cd /tmp
 
  cd /tmp
  <nowiki>wget http://smemirror.fullnet.co.uk/contribs/mblotwijk/Contribs/lazy-admin-tools/e-smith-lazy_admin_tools-0.9.0-1.noarch.rpm</nowIki>
+
  <nowiki>wget http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/e-smith-lazy_admin_tools-0.9.0-1.noarch.rpm</nowIki>
 
  yum localinstall e-smith-lazy_admin_tools
 
  yum localinstall e-smith-lazy_admin_tools
  
 
More information, examples, and source code can be downloaded from http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/
 
More information, examples, and source code can be downloaded from http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/
  
====UPGRADE NOTES====
+
====Upgrade notes====
1. If you are upgrading from a version prior to 0.7.0-1, don't forget to remove manually the old scripts. RPM will not be able to find and remove them for you.
+
1. If you are upgrading from a version prior to 0.7.0-1, don't forget to remove manually the old scripts. Yum will not be able to find and remove them for you.
  
 
2. As from version 0.7.0-1 the arguments for lat-groups have changed. Please refer to 'man lat-groups' or to the examples in /usr/doc/lazy-admin-tools for the new format.
 
2. As from version 0.7.0-1 the arguments for lat-groups have changed. Please refer to 'man lat-groups' or to the examples in /usr/doc/lazy-admin-tools for the new format.
  
===USAGE===
+
===Usage===
 
 
 
Each tool has its own comprehensive man page. See `man lazy-admin-tools` for an overview of the tools that have been installed.
 
Each tool has its own comprehensive man page. See `man lazy-admin-tools` for an overview of the tools that have been installed.
  
 
All tools follow the same concept:
 
All tools follow the same concept:
  
1.  Arguments can be specified on the command line (--comand-line), or in a file (--input-file) for batch processing.
+
1.  Arguments can be specified on the command line (--command-line), or in a file (--input-file) for batch processing.
  
 
2.  If the arguments are specified on the command line, the arguments must be between quotes (e.g. -c="foo | bar | baz")
 
2.  If the arguments are specified on the command line, the arguments must be between quotes (e.g. -c="foo | bar | baz")
Line 90: Line 70:
 
4.  See the various examples in /usr/doc/lazy-admin-tools for the format of the input file.
 
4.  See the various examples in /usr/doc/lazy-admin-tools for the format of the input file.
  
 +
----
 
[[Category:Howto]] [[Category:Administration]]
 
[[Category:Howto]] [[Category:Administration]]

Revision as of 23:00, 18 November 2007

Description

The Lazy Administrator's Tools is a set of scripts designed to automate batch tasks and administration jobs for SME servers. Currently the following tools are available:

Important.png Note:
This HowTo is based on a version in the contribs area by Michiel Blotwijk. The latest release was for SME 5.5/5.6/6.0 but some functions work in SME Server version 7.x as well.

This version was imported on November 18th, 2007. The original text can be found here


Available functions

Command Description
lat-users add/delete users (and their directories)
lat-groups add/delete groups
lat-pseudonyms add/delete e-mail pseudonyms for individual users
lat-ibays add/delete ibays (and its directories)
lat-quota set the disk quota for individual users
lat-procmail activate or deactivate procmail for individual users
lat-hosts add hostnames to the server
lat-pptp activate or deactivate pptp access for individualusers
lat-domains create virtual domains
lat-dump create input files for the above, using the configuration files of the SME servers.


Warning.png Warning:
SME Server 7.x supports the use of '@' in pseudonyms, but lat-pseudonym does not by default. See this forum post for a work-around.


Installation

Download and install using the following commands:

cd /tmp
wget http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/e-smith-lazy_admin_tools-0.9.0-1.noarch.rpm
yum localinstall e-smith-lazy_admin_tools

More information, examples, and source code can be downloaded from http://mirror.contribs.org/contribs/mblotwijk/Contribs/lazy-admin-tools/

Upgrade notes

1. If you are upgrading from a version prior to 0.7.0-1, don't forget to remove manually the old scripts. Yum will not be able to find and remove them for you.

2. As from version 0.7.0-1 the arguments for lat-groups have changed. Please refer to 'man lat-groups' or to the examples in /usr/doc/lazy-admin-tools for the new format.

Usage

Each tool has its own comprehensive man page. See `man lazy-admin-tools` for an overview of the tools that have been installed.

All tools follow the same concept:

1. Arguments can be specified on the command line (--command-line), or in a file (--input-file) for batch processing.

2. If the arguments are specified on the command line, the arguments must be between quotes (e.g. -c="foo | bar | baz")

3. Most tools recognize the wildcards * and ? in the first argument (e.g -c="foo* | bar | baz").

4. See the various examples in /usr/doc/lazy-admin-tools for the format of the input file.