I2Mobile

2016-06-30T18:19:38Z

Matthias: /* Installation */

i2Mobile (beta) is a lightweight web interface for Icinga2, designed for mobile clients, running on Apache, it is based on the API (Rest) interface of [https://www.icinga.org/ Icinga2]. 
The aim of this is to have a simple, easy and fast client for mobile phones. 
{|align=right
|__TOC__
|}
'''Features'''
*Using the Icinga2 API to retrieve the status, no more status.cgi
*Fast and Bandwidth friendly (less data)
*Display hosts and services with the state of error, warning and ok
*Suppress hosts and services when they are acknowledged or unknown.
*Additional suppress host and services by custom attributes

 
=Requirements=
 
* Linux, Apache and Perl for the WebUI
* Access to the Icinga2 API Host
 

=Screenshots=
 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''All hosts and services are running'''
[[image:I2mobile-allgood.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Warnings present'''
[[image:I2mobile-srvwarn.png|320px|left]]
|}

 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''Critical Errors'''
[[image:I2mobile-srvandhosterror.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Warnings and Crticals'''
[[image:I2mobile-srvandhostwarnanderror.png|320px|left]]
|}

 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''Service List'''
[[image:i2mobile-srvlist.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Service Detail'''
[[image:I2mobile-srvdetail.png|320px|left]]
|}

 

=Installation=
'''Note: The scripts has been tested on Debian 8 with Apache 2.4'''
*Get the tar file from the link below
*Unextract
*Copy the entire web directory to your www root, in this example /var/www/i2mobile
*Make your Apache user owner of the new target directory and files
*Copy the configuration example to /etc/i2mobile.xml
*Copy the web config template to /etc/apache2/sites-available/i2mobile.domain.com.conf
**Configure and rename the web config to your requriements
 
*Setup Apache, enable the web site and switch on the cgi module, example:
a2ensite i2mobile.domain.com
a2enmod cgi

*Install the required perl modules using MCPAN:
# perl -MCPAN -e 'install REST::Client'
# perl -MCPAN -e 'install JSON'
# perl -MCPAN -e 'install MIME::Base64'
# perl -MCPAN -e 'install Data::Dumper'
# perl -MCPAN -e 'install Data::GUID'

=Configure i2Mobile=
Configuration is done in /etc/i2mobile.xml. These are the minimum settings:

*'''IcingaHost='''URL and Port to the Icinga2 Host
*'''Password='''The password
*'''CookieAuthentication='''Optional authentication using a session cookie
*'''Contact='''Optional contact information
*'''URL='''=Optional Site URL

'''Example:'''
<?xml version="1.0" encoding="UTF-8"?>
<CONFIG>
<System
IcingaHost="https://your.ip.here:5665"
Password="user:123456789"
CookieAuthentication="0"
Contact="you@domain.com"
URL="http://i2mobile.domain.com"></System>
</CONFIG>

'''Thats it, setup is finsihed.'''
 

=Display options=
Services and hosts can be hided in i2Mobile, the idea is to show only important information and hide services and hosts which are not interested for the mobile user
*Service sample
apply Service "Something" {
...
//this will hide the service from i2Mobile
vars.is_ignore = "1"
}
*Host sample
apply Host "Something" {
...
//this will hide the host from i2Mobile
vars.is_ignore = "1"
}

=Authentication options=
Authentication can be established using the Apache htaccess options, however, there is the alternative option to work with session cookies which is '''less secure''' 
but allows the i2Mobile user to access the web quickly with no authentication prompt. The idea of session cookies is to create a GUID, keep it local in i2mobile.xml
and use it as reference. A helper page is available to add the session cookie on the client mobile browser. 
'''Sample'''
*CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
*Link to add the session cookie to the client browser:
**http://i2mobile.domain.com/setsessioncookie.pl?id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
**Client can now access the page without additional authentication
'''Full configuration sample'''
*i2mobile.xml
<Authentication
Enabled="1"
CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
Name="John Public"
MailTo="jp@domain.com"
Expire="20180701"
</Authentication>
From the above sample it is possible to immediate disable the web access by setting Enabled to 0 or set the Expire to yesterday. 
You may also use a small tool called addsc.pl which is available within the web directory, this will add the record to the configuration. 
'''Debugging''' 
A status page is available to obtain the validly of the session cookie
*http://i2mobile.domain.com/env.pl
 

=Download=
 
{| style="width: 70%;"
|style="width:30%; vertical-align: top;"|
'''Download the script''' 
Version 1.0 - 16KB 
[[File:Download.png|60px|link=http://coolscript.org/download/i2mobile.1.0.tar.gz|Download]]
 
|style="width:70%; vertical-align: top;"|
 
|}

 <hr> 

'''Feedbacks or comments are very welcome, no matter which direction. Please send to postmaster at coolscript.org'''

Main Page

2016-06-30T18:16:06Z

Matthias:

'''Welcome to Coolscript'''

These are just a few scripts which you may use for your IT-System purposes. This site is almost new and more scripts will follow soon.

{|
| Logrotation and file archive management script: || '''[[Logd]]'''
|-
| Eventlog to Firewall script for Windows 2008: || '''[[Eventlog to Firewall]]'''
|-
| Syslog to Firewall script for Linux: || '''[[Syslog_to_Firewall]]'''
|-
| Scheduled Task for Windows: || '''[[Scheduled Task for Windows]]'''
|-
| Spamassassin Plugin for Geo purposes: || '''[[GeoMailSearch]]'''
|-
| Raspberry Projects || '''[[RaspberryProjects]]'''
|-
| PSAD to Iptables: || '''[[psad2ipt]]'''
|-
| Icinga2 Web Interface for Smartphones || '''[[i2Mobile]]'''
|}

 

My other sites which might be useful
{|
| All about IP 4/6 and locations to lat/lon: || http://coolgeo.org
|-
| The Coolgeo XML API Wiki: || http://wiki.coolgeo.org
|-
| Another password creator || http://coolpassword.org
|-
| Analyze your mail header: || http://mailheader.org
|}

 

Questions, feedback or recommendations are welcome, drop me a mail to postmaster at coolscript.org.

Main Page

2016-06-30T18:14:55Z

Matthias:

Main Page

2016-06-30T17:56:39Z

Matthias:

'''Welcome to Coolscript'''

These are just a few scripts which you may use for your IT-System purposes. This site is almost new and more scripts will follow soon.

{|
| Logrotation and file archive management script: || '''[[Logd]]'''
|-
| Eventlog to Firewall script for Windows 2008: || '''[[Eventlog to Firewall]]'''
|-
| Syslog to Firewall script for Linux: || '''[[Syslog_to_Firewall]]'''
|-
| Scheduled Task for Windows: || '''[[Scheduled Task for Windows]]'''
|-
| Spamassassin Plugin for Geo purposes: || '''[[GeoMailSearch]]'''
|-
| Raspberry Projects || '''[[RaspberryProjects]]'''
|-
| PSAD to Iptables: || '''[[psad2ipt]]'''
|-
| Icinga2 Web Interface for Smartphones || '''[[i2Mobile]]'''
|}

 

Questions, feedback or recommendations are welcome, mailto postmaster at coolscript.org.

Main Page

2016-06-30T17:56:22Z

Matthias:

'''Welcome to Coolscript'''

These are just a few scripts which you may use for your IT-System purposes. This site is new and more scripts will follow soon.

{|
| Logrotation and file archive management script: || '''[[Logd]]'''
|-
| Eventlog to Firewall script for Windows 2008: || '''[[Eventlog to Firewall]]'''
|-
| Syslog to Firewall script for Linux: || '''[[Syslog_to_Firewall]]'''
|-
| Scheduled Task for Windows: || '''[[Scheduled Task for Windows]]'''
|-
| Spamassassin Plugin for Geo purposes: || '''[[GeoMailSearch]]'''
|-
| Raspberry Projects || '''[[RaspberryProjects]]'''
|-
| PSAD to Iptables: || '''[[psad2ipt]]'''
|-
| Icinga2 Web Interface for Smartphones || '''[[i2Mobile]]'''
|}

 

Questions, feedback or recommendations are welcome, mailto postmaster at coolscript.org.

Main Page

2016-06-30T17:49:51Z

Matthias:

'''Welcome to Coolscript'''

Bla
These are just a few scripts which you may use for your IT-System purposes. This site is new and more scripts will follow soon.

{|
| Logrotation and file archive management script: || '''[[Logd]]'''
|-
| Eventlog to Firewall script for Windows 2008: || '''[[Eventlog to Firewall]]'''
|-
| Syslog to Firewall script for Linux: || '''[[Syslog_to_Firewall]]'''
|-
| Scheduled Task for Windows: || '''[[Scheduled Task for Windows]]'''
|-
| Spamassassin Plugin for Geo purposes: || '''[[GeoMailSearch]]'''
|-
| Raspberry Projects || '''[[RaspberryProjects]]'''
|-
| PSAD to Iptables: || '''[[psad2ipt]]'''
|-
| Icinga2 Web Interface for Smartphones || '''[[i2Mobile]]'''
|}

 

Questions, feedback or recommendations are welcome, mailto postmaster at coolscript.org.

I2Mobile

2016-06-30T14:46:24Z

Matthias: /* Screenshots */

i2Mobile (beta) is a lightweight web interface for Icinga2, designed for mobile clients, running on Apache, it is based on the API (Rest) interface of [https://www.icinga.org/ Icinga2]. 
The aim of this is to have a simple, easy and fast client for mobile phones. 
{|align=right
|__TOC__
|}
'''Features'''
*Using the Icinga2 API to retrieve the status, no more status.cgi
*Fast and Bandwidth friendly (less data)
*Display hosts and services with the state of error, warning and ok
*Suppress hosts and services when they are acknowledged or unknown.
*Additional suppress host and services by custom attributes

 
=Requirements=
 
* Linux, Apache and Perl for the WebUI
* Access to the Icinga2 API Host
 

=Screenshots=
 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''All hosts and services are running'''
[[image:I2mobile-allgood.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Warnings present'''
[[image:I2mobile-srvwarn.png|320px|left]]
|}

 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''Critical Errors'''
[[image:I2mobile-srvandhosterror.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Warnings and Crticals'''
[[image:I2mobile-srvandhostwarnanderror.png|320px|left]]
|}

 
{| style="width: 50%;"
|style="width:40%; vertical-align: top;"|
*'''Service List'''
[[image:i2mobile-srvlist.png|320px|left]]
|style="width:40%; vertical-align: top;"|
*'''Service Detail'''
[[image:I2mobile-srvdetail.png|320px|left]]
|}

 

=Installation=
'''Note: The scripts has been tested on Debian 8 with Apache 2.4'''
*Get the tar file from the link below
*Unextract
*Copy the entire web directory to your www root, in this example /var/www/i2mobile
*Make your Apache user of the new target directory and files
*Copy the configuration example to /etc/i2mobile.xml
*Copy the web config template to /etc/apache2/sites-available/i2mobile.domain.com.conf
**Configure and rename the web config to your requriements
 
*Setup Apache, enable the web site and switch on the cgi module, example:
a2ensite i2mobile.domain.com
a2enmod cgi

*Install the required perl modules using MCPAN:
# perl -MCPAN -e 'install REST::Client'
# perl -MCPAN -e 'install JSON'
# perl -MCPAN -e 'install MIME::Base64'
# perl -MCPAN -e 'install Data::Dumper'
# perl -MCPAN -e 'install Data::GUID'
=Configure i2Mobile=
Configuration is done in /etc/i2mobile.xml. These are the minimum settings:

*'''IcingaHost='''URL and Port to the Icinga2 Host
*'''Password='''The password
*'''CookieAuthentication='''Optional authentication using a session cookie
*'''Contact='''Optional contact information
*'''URL='''=Optional Site URL

'''Example:'''
<?xml version="1.0" encoding="UTF-8"?>
<CONFIG>
<System
IcingaHost="https://your.ip.here:5665"
Password="user:123456789"
CookieAuthentication="0"
Contact="you@domain.com"
URL="http://i2mobile.domain.com"></System>
</CONFIG>

'''Thats it, setup is finsihed.'''
 

=Display options=
Services and hosts can be hided in i2Mobile, the idea is to show only important information and hide services and hosts which are not interested for the mobile user
*Service sample
apply Service "Something" {
...
//this will hide the service from i2Mobile
vars.is_ignore = "1"
}
*Host sample
apply Host "Something" {
...
//this will hide the host from i2Mobile
vars.is_ignore = "1"
}

=Authentication options=
Authentication can be established using the Apache htaccess options, however, there is the alternative option to work with session cookies which is '''less secure''' 
but allows the i2Mobile user to access the web quickly with no authentication prompt. The idea of session cookies is to create a GUID, keep it local in i2mobile.xml
and use it as reference. A helper page is available to add the session cookie on the client mobile browser. 
'''Sample'''
*CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
*Link to add the session cookie to the client browser:
**http://i2mobile.domain.com/setsessioncookie.pl?id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
**Client can now access the page without additional authentication
'''Full configuration sample'''
*i2mobile.xml
<Authentication
Enabled="1"
CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
Name="John Public"
MailTo="jp@domain.com"
Expire="20180701"
</Authentication>
From the above sample it is possible to immediate disable the web access by setting Enabled to 0 or set the Expire to yesterday. 
You may also use a small tool called addsc.pl which is available within the web directory, this will add the record to the configuration. 
'''Debugging''' 
A status page is available to obtain the validly of the session cookie
*http://i2mobile.domain.com/env.pl
 

=Download=
 
{| style="width: 70%;"
|style="width:30%; vertical-align: top;"|
'''Download the script''' 
Version 1.0 - 16KB 
[[File:Download.png|60px|link=http://coolscript.org/download/i2mobile.1.0.tar.gz|Download]]
 
|style="width:70%; vertical-align: top;"|
 
|}

 <hr> 

'''Feedbacks or comments are very welcome, no matter which direction. Please send to postmaster at coolscript.org'''

2016-06-30T14:40:47Z

2016-02-04T22:12:49Z

Matthias: /* Perl Modules */

=About=
This is a alternative and easy way to run scheduled tasks on Windows. It is useful to workaround access or group policy restrictions, for example if your group policy logs you out after a short period and you want your scheduled tasks keep on running. 
The script has been tested to run as service using '''srvany.exe''' but it is possible to run the script in a common way
(eg: perl st.pl -c path/configfile) but we intend to run it as service.

 

=Features=
*Can run scheduled programs every minute, hour, day or week
*Protocol events in a xml file
*Log all activities
 

=Requirements=
*MS Windows 7 or higher or Server2012 or higher
*srvany.exe (to run the script as service)
*Active State Perl >= 5.14 or Strawberry Perl >=5.22
*Additional Modules:
**Win32::Process
**Win32::Process::List
**Date::Manip
 

=Installation=
Uncompress and copy the files to a directory of you your choice, this example is using c:\scheduled-task
 
These are the required script files:
*c:\scheduled-task\st.pl
*c:\scheduled-task\st.xml

There is a optional plugin for Nagios / Icinga available, please see:
*check_st.pl
 

==Perl Modules==
It is possible to use either Active State or Strawberry Perl
===Active State===
You need to have a recent version of active state perl installed, when done please run the following installation commands:
Note that Active State doesn't allow Date-Manip to be installed with it's recent community version as of December 2016.
ppm install Win32-Process
ppm install Win32-Process-list
ppm install Date-Manip
===Strawberry===
Run cpan first to get the installation shell.
cpan> '''install Win32:Process:List'''
cpan> '''install Date:Manip'''
 

==Service==
Note: It is possible to install the service with or without a service description.

===Service Registration===
Get the tool srvany.exe and copy it to c:\windows\system32\, then register the service by running:
sc create Perl-Scheduled-Task binPath= C:\Windows\System32\srvany.exe DisplayName= Perl-Scheduled-Task

Optional you may want to set a description for the service:
sc description Perl-Scheduled-Task "Schedule Task Manager for Perl"

Please don't forget to set enough permissions for the new task.
 

===Service Configuration===
Open your registry and add the key '''Parmeters''':
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Perl-Scheduled-Task\'''Parameters''']
*Add a string value called '''Application''' within '''Parameters''' and add the path to perl and the path to the script:
"Application"="c:\\perl\\bin\\perl.exe c:\\scheduled-task\\st.pl -c c:\\scheduled-task\\st.xml"

*Check your service permission, make sure the service user has enough permissions to start applications and has edit and create right in its application directory.

 

==Script Configuration==
Description of the configuration file used with st.pl. 
Note: Please use the forward slash as a directory separator like on linux even on windows, this way we get no trouble with escape sequences. 
Default Filename: '''st.xml''' 
'''Security information:''' Please keep this file secure, only authorized accounts should be able to edit the configuration file. 
{| class="wikitable " border="1"
|+ '''st.xml'''
|-
! scope="col" | Element
! scope="col" | Array
! scope="col" | Attribute
! scope="col" | Description

|-
| System || No || ApplicationDirectory || Path to appliactaion
|-
| || || StatusFile || Path and Name to Status File, leave empty or set zero to disable
|-
| || || Log || Switch on logging (0/1)
|-
| || || LogAge || Maximum logfile age (days) before deleting them.
|-
| || || LogDirectory || Path to Log Directory
|-

| ScheduledTask || Yes || Enabled || Job enable (1/0)
|-
| || || Name || Any Jobname
|-
| || || ApplicationPath || Path to perl, eg: c:/perl64/bin/perl.exe
|-
| || || ApplicationParameter || Path to the script, eg: c:/scheduled-task/st.xml
|-
| || || ApplicationPriority || Available: '''Below''' or '''Normal'''
|-
| || || Mode || Currently only '''Repeat'''
|-
| || || FrequencyUnit || M=Every Minute D=Daily W=Weekly
|-
| || || FrequencyInterval || Only with Mode=M, the interval in minutes for the scheduled task
|-
| || || FrequencyOffset || Only with Mode=M, adding minutes to the next scheduled task
|-
| || || FrequencyTime || Only with Mode=D or W, the time (HH:MM) for the scheduled task
|-
| || || FrequencyDay || Only with Mode=W, a csv list of the weekday for the scheduled task The following abbrevitions can be used, capitals or ordering do not matter Mo,Tu,We,Th,Fr,Sa,Su Mon,Tue,Wed,Thu,Fri,Sat,Sun Monday,Tuesday,Wednesday,Thuesday,Friday,Saturday,Sunday 0,1,2,3,4,5,6 
|-
| || || IsUnique || (0/1) Specify if the job is allowed to run once only.
|-
|}

===Examples===
*Run 2 Jobs every 5 and every 20 minutes. 
<?xml version="1.0"?>
<CONFIG>

<System
ApplicationDirectory="c:/demo/scheduled-task/"
StatusFile="0"
Log="0"
LogAge="0"
LogDirectory=""
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/job.pl"
ApplicationPriority="Below"
Mode="Repeat"
FrequencyUnit="M"
FrequencyInterval="5"
FrequencyOffset="0"
IsUnique="1"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/anotherjob.pl"
ApplicationPriority="Normal"
Mode="Repeat"
FrequencyUnit="M"
FrequencyInterval="20"
FrequencyOffset="5"
IsUnique="1"
/>

*Run 2 Jobs every day at 01:00 and every working day (mo-fr) at 05:00 
<?xml version="1.0"?>
<CONFIG>

<System
ApplicationDirectory="c:/demo/scheduled-task/"
StatusFile="0"
Log="1"
LogAge="14"
LogDirectory="c:/demo/scheduled-task/log/"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/job.pl"
ApplicationPriority="Below"
Mode="Repeat"
FrequencyUnit="D"
FrequencyTime="01:00"
IsUnique="1"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/anotherjob.pl"
ApplicationPriority="Normal"
Mode="Repeat"
FrequencyUnit="W"
FrequencyDay="mo,tu,we,th,fr"
FrequencyTime="05:00"
IsUnique="1"
/>

 

==Status File==
A XML status file is available to obtain the current status of the application,
the file is read only. 
Structure:
{| class="wikitable " border="1"
|+ '''st.xml'''
|-
! scope="col" | Element
! scope="col" | Array
! scope="col" | Attribute
! scope="col" | Description

|-
| Status || No || Process || Scheduled Task Process Information
|-
| || || Pid || The Process Identifier
|-
| || || StartDate || Startup Date (yyyy-mm-dd hh:mm:ss)
|-
| || || LastCheckDate || Last Event Date (yyyy-mm-dd hh:mm:ss)
|-

| ScheduledTask || Yes || Name || The Job Name
|-
| || || Enabled || (0/1) Job Enabled
|-
| || || PID || The current PID of the scheduled task, is zero if the process does not run
|-
| || || START || The last start event (yyyy-mm-dd hh:mm:ss)
|-
| || || END || The last end event (yyyy-mm-dd hh:mm:ss)
|-
| || || NEXT || The next start event (yyyy-mm-dd hh:mm:ss)
|-
|}

{| style="width: 70%;"
|style="width:10%; vertical-align: top;"|
'''Download the script''' 
[[File:Download.png|60px|link=http://coolscript.org/download/st.zip|Download]]
 
|style="width:90%; vertical-align: top;"|
 

|}

Scheduled Task for Windows

2016-02-04T22:12:41Z

Matthias: /* Perl Modules */

Scheduled Task for Windows

2016-02-04T22:11:27Z

Matthias: /* About */

=About=
This is a alternative and easy way to run scheduled tasks on Windows. It is useful to workaround access or group policy restrictions, for example if your group policy logs you out after a short period and you want your scheduled tasks keep on running. 
The script has been tested to run as service using '''srvany.exe''' but it is possible to run the script in a common way
(eg: perl st.pl -c path/configfile) but we intend to run it as service.

 

=Features=
*Can run scheduled programs every minute, hour, day or week
*Protocol events in a xml file
*Log all activities
 

=Requirements=
*MS Windows 7 or higher or Server2012 or higher
*srvany.exe (to run the script as service)
*Active State Perl >= 5.14 or Strawberry Perl >=5.22
*Additional Modules:
**Win32::Process
**Win32::Process::List
**Date::Manip
 

=Installation=
Uncompress and copy the files to a directory of you your choice, this example is using c:\scheduled-task
 
These are the required script files:
*c:\scheduled-task\st.pl
*c:\scheduled-task\st.xml

There is a optional plugin for Nagios / Icinga available, please see:
*check_st.pl
 

==Perl Modules==
You need to have a recent version of active state perl installed, when done please run the following installation commands:
===Active State===
Note that Active State doesn't allow Date-Manip to be installed with it's recent community version as of December 2016.
ppm install Win32-Process
ppm install Win32-Process-list
ppm install Date-Manip
===Strawberry===
Run cpan first to get the installation shell.
cpan> '''install Win32:Process:List'''
cpan> '''install Date:Manip'''
 

==Service==
Note: It is possible to install the service with or without a service description.

===Service Registration===
Get the tool srvany.exe and copy it to c:\windows\system32\, then register the service by running:
sc create Perl-Scheduled-Task binPath= C:\Windows\System32\srvany.exe DisplayName= Perl-Scheduled-Task

Optional you may want to set a description for the service:
sc description Perl-Scheduled-Task "Schedule Task Manager for Perl"

Please don't forget to set enough permissions for the new task.
 

===Service Configuration===
Open your registry and add the key '''Parmeters''':
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Perl-Scheduled-Task\'''Parameters''']
*Add a string value called '''Application''' within '''Parameters''' and add the path to perl and the path to the script:
"Application"="c:\\perl\\bin\\perl.exe c:\\scheduled-task\\st.pl -c c:\\scheduled-task\\st.xml"

*Check your service permission, make sure the service user has enough permissions to start applications and has edit and create right in its application directory.

 

==Script Configuration==
Description of the configuration file used with st.pl. 
Note: Please use the forward slash as a directory separator like on linux even on windows, this way we get no trouble with escape sequences. 
Default Filename: '''st.xml''' 
'''Security information:''' Please keep this file secure, only authorized accounts should be able to edit the configuration file. 
{| class="wikitable " border="1"
|+ '''st.xml'''
|-
! scope="col" | Element
! scope="col" | Array
! scope="col" | Attribute
! scope="col" | Description

|-
| System || No || ApplicationDirectory || Path to appliactaion
|-
| || || StatusFile || Path and Name to Status File, leave empty or set zero to disable
|-
| || || Log || Switch on logging (0/1)
|-
| || || LogAge || Maximum logfile age (days) before deleting them.
|-
| || || LogDirectory || Path to Log Directory
|-

| ScheduledTask || Yes || Enabled || Job enable (1/0)
|-
| || || Name || Any Jobname
|-
| || || ApplicationPath || Path to perl, eg: c:/perl64/bin/perl.exe
|-
| || || ApplicationParameter || Path to the script, eg: c:/scheduled-task/st.xml
|-
| || || ApplicationPriority || Available: '''Below''' or '''Normal'''
|-
| || || Mode || Currently only '''Repeat'''
|-
| || || FrequencyUnit || M=Every Minute D=Daily W=Weekly
|-
| || || FrequencyInterval || Only with Mode=M, the interval in minutes for the scheduled task
|-
| || || FrequencyOffset || Only with Mode=M, adding minutes to the next scheduled task
|-
| || || FrequencyTime || Only with Mode=D or W, the time (HH:MM) for the scheduled task
|-
| || || FrequencyDay || Only with Mode=W, a csv list of the weekday for the scheduled task The following abbrevitions can be used, capitals or ordering do not matter Mo,Tu,We,Th,Fr,Sa,Su Mon,Tue,Wed,Thu,Fri,Sat,Sun Monday,Tuesday,Wednesday,Thuesday,Friday,Saturday,Sunday 0,1,2,3,4,5,6 
|-
| || || IsUnique || (0/1) Specify if the job is allowed to run once only.
|-
|}

===Examples===
*Run 2 Jobs every 5 and every 20 minutes. 
<?xml version="1.0"?>
<CONFIG>

<System
ApplicationDirectory="c:/demo/scheduled-task/"
StatusFile="0"
Log="0"
LogAge="0"
LogDirectory=""
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/job.pl"
ApplicationPriority="Below"
Mode="Repeat"
FrequencyUnit="M"
FrequencyInterval="5"
FrequencyOffset="0"
IsUnique="1"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/anotherjob.pl"
ApplicationPriority="Normal"
Mode="Repeat"
FrequencyUnit="M"
FrequencyInterval="20"
FrequencyOffset="5"
IsUnique="1"
/>

*Run 2 Jobs every day at 01:00 and every working day (mo-fr) at 05:00 
<?xml version="1.0"?>
<CONFIG>

<System
ApplicationDirectory="c:/demo/scheduled-task/"
StatusFile="0"
Log="1"
LogAge="14"
LogDirectory="c:/demo/scheduled-task/log/"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/job.pl"
ApplicationPriority="Below"
Mode="Repeat"
FrequencyUnit="D"
FrequencyTime="01:00"
IsUnique="1"
/>

<ScheduledTask
Enabled="1"
Name="Demo Job"
ApplicationPath="c:/perl/bin/perl.exe"
ApplicationParameter="C:/demo/anotherjob.pl"
ApplicationPriority="Normal"
Mode="Repeat"
FrequencyUnit="W"
FrequencyDay="mo,tu,we,th,fr"
FrequencyTime="05:00"
IsUnique="1"
/>

 

==Status File==
A XML status file is available to obtain the current status of the application,
the file is read only. 
Structure:
{| class="wikitable " border="1"
|+ '''st.xml'''
|-
! scope="col" | Element
! scope="col" | Array
! scope="col" | Attribute
! scope="col" | Description

|-
| Status || No || Process || Scheduled Task Process Information
|-
| || || Pid || The Process Identifier
|-
| || || StartDate || Startup Date (yyyy-mm-dd hh:mm:ss)
|-
| || || LastCheckDate || Last Event Date (yyyy-mm-dd hh:mm:ss)
|-

| ScheduledTask || Yes || Name || The Job Name
|-
| || || Enabled || (0/1) Job Enabled
|-
| || || PID || The current PID of the scheduled task, is zero if the process does not run
|-
| || || START || The last start event (yyyy-mm-dd hh:mm:ss)
|-
| || || END || The last end event (yyyy-mm-dd hh:mm:ss)
|-
| || || NEXT || The next start event (yyyy-mm-dd hh:mm:ss)
|-
|}

{| style="width: 70%;"
|style="width:10%; vertical-align: top;"|
'''Download the script''' 
[[File:Download.png|60px|link=http://coolscript.org/download/st.zip|Download]]
 
|style="width:90%; vertical-align: top;"|
 

|}