CheckExternalScriptsCheckExternalScripts — CheckExternalScripts¶Execute external scripts
Aliases (Overview):
A list of all short hand aliases for queries (check commands)
| Command | Description |
|---|---|
| alias_cpu | Alias for: check_cpu |
| alias_cpu_ex | Alias for: check_cpu |
| alias_disk | Alias for: check_drivesize |
| alias_disk_loose | Alias for: check_drivesize |
| alias_event_log | Alias for: check_eventlog |
| alias_file_age | Alias for: check_files |
| alias_file_size | Alias for: check_files |
| alias_mem | Alias for: check_memory |
| alias_process | Alias for: check_process |
| alias_process_count | Alias for: check_process |
| alias_process_hung | Alias for: check_process |
| alias_process_stopped | Alias for: check_process |
| alias_sched_all | Alias for: check_tasksched |
| alias_sched_long | Alias for: check_tasksched |
| alias_sched_task | Alias for: check_tasksched |
| alias_service | Alias for: check_service |
| alias_service_ex | Alias for: check_service |
| alias_up | Alias for: check_uptime |
| alias_volumes | Alias for: check_drivesize |
| alias_volumes_loose | Alias for: check_drivesize |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Sample keys:
| Path / Section | Key | Default Value | Description |
|---|---|---|---|
/settings/external scripts/alias/sample |
alias |
ALIAS | |
/settings/external scripts/alias/sample |
command |
COMMAND | |
/settings/external scripts/alias/sample |
is template |
IS TEMPLATE | |
/settings/external scripts/alias/sample |
parent |
PARENT | |
/settings/external scripts/scripts/sample |
alias |
ALIAS | |
/settings/external scripts/scripts/sample |
command |
COMMAND | |
/settings/external scripts/scripts/sample |
domain |
DOMAIN | |
/settings/external scripts/scripts/sample |
encoding |
ENCODING | |
/settings/external scripts/scripts/sample |
ignore perfdata |
IGNORE PERF DATA | |
/settings/external scripts/scripts/sample |
is template |
IS TEMPLATE | |
/settings/external scripts/scripts/sample |
parent |
PARENT | |
/settings/external scripts/scripts/sample |
password |
PASSWORD | |
/settings/external scripts/scripts/sample |
user |
USER |
/settings/external scripts (CheckExternalScripts)¶EXTERNAL SCRIPT SECTION
Section for external scripts configuration options (CheckExternalScripts).
Key Default Value Description allow arguments0 COMMAND ARGUMENT PROCESSING allow nasty characters0 COMMAND ALLOW NASTY META CHARS script pathSCRIPT DIRECTORY timeout60 COMMAND TIMEOUT Sample:
# EXTERNAL SCRIPT SECTION # Section for external scripts configuration options (CheckExternalScripts). [/settings/external scripts] allow arguments=0 allow nasty characters=0 script path= timeout=60
allow arguments(CheckExternalScripts, /settings/external scripts)¶COMMAND ARGUMENT PROCESSING
This option determines whether or not the we will allow clients to specify arguments to commands that are executed.Path: /settings/external scripts
Key: allow arguments
Default value: 0
Used by:
CheckExternalScriptsSample:
[/settings/external scripts] # COMMAND ARGUMENT PROCESSING allow arguments=0
allow nasty characters(CheckExternalScripts, /settings/external scripts)¶COMMAND ALLOW NASTY META CHARS
This option determines whether or not the we will allow clients to specify nasty (as in |`&><’”\[]{}) characters in arguments.Path: /settings/external scripts
Key: allow nasty characters
Default value: 0
Used by:
CheckExternalScriptsSample:
[/settings/external scripts] # COMMAND ALLOW NASTY META CHARS allow nasty characters=0
script path(CheckExternalScripts, /settings/external scripts)¶SCRIPT DIRECTORY
Load all scripts in a directory and use them as commands. Probably dangerous but useful if you have loads of scripts :)Path: /settings/external scripts
Key: script path
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts] # SCRIPT DIRECTORY script path=
timeout(CheckExternalScripts, /settings/external scripts)¶COMMAND TIMEOUT
The maximum time in seconds that a command can execute. (if more then this execution will be aborted). NOTICE this only affects external commands not internal ones.Path: /settings/external scripts
Key: timeout
Default value: 60
Used by:
CheckExternalScriptsSample:
[/settings/external scripts] # COMMAND TIMEOUT timeout=60
/settings/external scripts/alias (CheckExternalScripts)¶ALIAS SECTION
A list of aliases available.An alias is an internal command that has been predefined to provide a single command without arguments. Be careful so you don’t create loops (ie check_loop=check_a, check_a=check_loop)
Key Default Value Description alias_cpualias_cpu alias_cpu_exalias_cpu_ex alias_diskalias_disk alias_disk_loosealias_disk_loose alias_event_logalias_event_log alias_file_agealias_file_age alias_file_sizealias_file_size alias_memalias_mem alias_processalias_process alias_process_countalias_process_count alias_process_hungalias_process_hung alias_process_stoppedalias_process_stopped alias_sched_allalias_sched_all alias_sched_longalias_sched_long alias_sched_taskalias_sched_task alias_servicealias_service alias_service_exalias_service_ex alias_upalias_up alias_volumesalias_volumes alias_volumes_loosealias_volumes_loose defaultdefault Sample:
# ALIAS SECTION # A list of aliases available. [/settings/external scripts/alias] alias_cpu= alias_cpu_ex= alias_disk= alias_disk_loose= alias_event_log= alias_file_age= alias_file_size= alias_mem= alias_process= alias_process_count= alias_process_hung= alias_process_stopped= alias_sched_all= alias_sched_long= alias_sched_task= alias_service= alias_service_ex= alias_up= alias_volumes= alias_volumes_loose= default=
alias_cpu(CheckExternalScripts, /settings/external scripts/alias)¶alias_cpu
Alias for alias_cpu. To configure this item add a section called: /settings/external scripts/alias/alias_cpuPath: /settings/external scripts/alias
Key: alias_cpu
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_cpu alias_cpu=
alias_cpu_ex(CheckExternalScripts, /settings/external scripts/alias)¶alias_cpu_ex
Alias for alias_cpu_ex. To configure this item add a section called: /settings/external scripts/alias/alias_cpu_exPath: /settings/external scripts/alias
Key: alias_cpu_ex
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_cpu_ex alias_cpu_ex=
alias_disk(CheckExternalScripts, /settings/external scripts/alias)¶alias_disk
Alias for alias_disk. To configure this item add a section called: /settings/external scripts/alias/alias_diskPath: /settings/external scripts/alias
Key: alias_disk
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_disk alias_disk=
alias_disk_loose(CheckExternalScripts, /settings/external scripts/alias)¶alias_disk_loose
Alias for alias_disk_loose. To configure this item add a section called: /settings/external scripts/alias/alias_disk_loosePath: /settings/external scripts/alias
Key: alias_disk_loose
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_disk_loose alias_disk_loose=
alias_event_log(CheckExternalScripts, /settings/external scripts/alias)¶alias_event_log
Alias for alias_event_log. To configure this item add a section called: /settings/external scripts/alias/alias_event_logPath: /settings/external scripts/alias
Key: alias_event_log
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_event_log alias_event_log=
alias_file_age(CheckExternalScripts, /settings/external scripts/alias)¶alias_file_age
Alias for alias_file_age. To configure this item add a section called: /settings/external scripts/alias/alias_file_agePath: /settings/external scripts/alias
Key: alias_file_age
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_file_age alias_file_age=
alias_file_size(CheckExternalScripts, /settings/external scripts/alias)¶alias_file_size
Alias for alias_file_size. To configure this item add a section called: /settings/external scripts/alias/alias_file_sizePath: /settings/external scripts/alias
Key: alias_file_size
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_file_size alias_file_size=
alias_mem(CheckExternalScripts, /settings/external scripts/alias)¶alias_mem
Alias for alias_mem. To configure this item add a section called: /settings/external scripts/alias/alias_memPath: /settings/external scripts/alias
Key: alias_mem
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_mem alias_mem=
alias_process(CheckExternalScripts, /settings/external scripts/alias)¶alias_process
Alias for alias_process. To configure this item add a section called: /settings/external scripts/alias/alias_processPath: /settings/external scripts/alias
Key: alias_process
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_process alias_process=
alias_process_count(CheckExternalScripts, /settings/external scripts/alias)¶alias_process_count
Alias for alias_process_count. To configure this item add a section called: /settings/external scripts/alias/alias_process_countPath: /settings/external scripts/alias
Key: alias_process_count
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_process_count alias_process_count=
alias_process_hung(CheckExternalScripts, /settings/external scripts/alias)¶alias_process_hung
Alias for alias_process_hung. To configure this item add a section called: /settings/external scripts/alias/alias_process_hungPath: /settings/external scripts/alias
Key: alias_process_hung
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_process_hung alias_process_hung=
alias_process_stopped(CheckExternalScripts, /settings/external scripts/alias)¶alias_process_stopped
Alias for alias_process_stopped. To configure this item add a section called: /settings/external scripts/alias/alias_process_stoppedPath: /settings/external scripts/alias
Key: alias_process_stopped
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_process_stopped alias_process_stopped=
alias_sched_all(CheckExternalScripts, /settings/external scripts/alias)¶alias_sched_all
Alias for alias_sched_all. To configure this item add a section called: /settings/external scripts/alias/alias_sched_allPath: /settings/external scripts/alias
Key: alias_sched_all
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_sched_all alias_sched_all=
alias_sched_long(CheckExternalScripts, /settings/external scripts/alias)¶alias_sched_long
Alias for alias_sched_long. To configure this item add a section called: /settings/external scripts/alias/alias_sched_longPath: /settings/external scripts/alias
Key: alias_sched_long
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_sched_long alias_sched_long=
alias_sched_task(CheckExternalScripts, /settings/external scripts/alias)¶alias_sched_task
Alias for alias_sched_task. To configure this item add a section called: /settings/external scripts/alias/alias_sched_taskPath: /settings/external scripts/alias
Key: alias_sched_task
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_sched_task alias_sched_task=
alias_service(CheckExternalScripts, /settings/external scripts/alias)¶alias_service
Alias for alias_service. To configure this item add a section called: /settings/external scripts/alias/alias_servicePath: /settings/external scripts/alias
Key: alias_service
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_service alias_service=
alias_service_ex(CheckExternalScripts, /settings/external scripts/alias)¶alias_service_ex
Alias for alias_service_ex. To configure this item add a section called: /settings/external scripts/alias/alias_service_exPath: /settings/external scripts/alias
Key: alias_service_ex
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_service_ex alias_service_ex=
alias_up(CheckExternalScripts, /settings/external scripts/alias)¶alias_up
Alias for alias_up. To configure this item add a section called: /settings/external scripts/alias/alias_upPath: /settings/external scripts/alias
Key: alias_up
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_up alias_up=
alias_volumes(CheckExternalScripts, /settings/external scripts/alias)¶alias_volumes
Alias for alias_volumes. To configure this item add a section called: /settings/external scripts/alias/alias_volumesPath: /settings/external scripts/alias
Key: alias_volumes
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_volumes alias_volumes=
alias_volumes_loose(CheckExternalScripts, /settings/external scripts/alias)¶alias_volumes_loose
Alias for alias_volumes_loose. To configure this item add a section called: /settings/external scripts/alias/alias_volumes_loosePath: /settings/external scripts/alias
Key: alias_volumes_loose
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # alias_volumes_loose alias_volumes_loose=
default(CheckExternalScripts, /settings/external scripts/alias)¶default
Alias for default. To configure this item add a section called: /settings/external scripts/alias/defaultPath: /settings/external scripts/alias
Key: default
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias] # default default=
/settings/external scripts/alias/sample (CheckExternalScripts)¶ALIAS DEFENITION
Alias definition for: sample
Key Default Value Description aliasALIAS commandCOMMAND is template0 IS TEMPLATE parentdefault PARENT Sample:
# ALIAS DEFENITION # Alias definition for: sample [/settings/external scripts/alias/sample] alias= command= is template=0 parent=default
alias(CheckExternalScripts, /settings/external scripts/alias/sample)¶ALIAS
The alias (service name) to report to serverAdvanced (means it is not commonly used)
Path: /settings/external scripts/alias/sample
Key: alias
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias/sample] # ALIAS alias=
command(CheckExternalScripts, /settings/external scripts/alias/sample)¶COMMAND
Command to executePath: /settings/external scripts/alias/sample
Key: command
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias/sample] # COMMAND command=
is template(CheckExternalScripts, /settings/external scripts/alias/sample)¶IS TEMPLATE
Declare this object as a template (this means it will not be available as a separate object)Advanced (means it is not commonly used)
Path: /settings/external scripts/alias/sample
Key: is template
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias/sample] # IS TEMPLATE is template=0
parent(CheckExternalScripts, /settings/external scripts/alias/sample)¶PARENT
The parent the target inherits fromAdvanced (means it is not commonly used)
Path: /settings/external scripts/alias/sample
Key: parent
Default value: default
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/alias/sample] # PARENT parent=default
/settings/external scripts/scripts (CheckExternalScripts)¶SCRIPT SECTION
A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>
Key Default Value Description defaultdefault Sample:
# SCRIPT SECTION # A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments> [/settings/external scripts/scripts] default=
default(CheckExternalScripts, /settings/external scripts/scripts)¶default
Alias for default. To configure this item add a section called: /settings/external scripts/scripts/defaultPath: /settings/external scripts/scripts
Key: default
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts] # default default=
/settings/external scripts/scripts/sample (CheckExternalScripts)¶COMMAND DEFENITION
Command definition for: sample
Key Default Value Description aliasALIAS commandCOMMAND domainDOMAIN encodingENCODING ignore perfdata0 IGNORE PERF DATA is template0 IS TEMPLATE parentdefault PARENT passwordPASSWORD userUSER Sample:
# COMMAND DEFENITION # Command definition for: sample [/settings/external scripts/scripts/sample] alias= command= domain= encoding= ignore perfdata=0 is template=0 parent=default password= user=
alias(CheckExternalScripts, /settings/external scripts/scripts/sample)¶ALIAS
The alias (service name) to report to serverAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: alias
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # ALIAS alias=
command(CheckExternalScripts, /settings/external scripts/scripts/sample)¶COMMAND
Command to executePath: /settings/external scripts/scripts/sample
Key: command
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # COMMAND command=
domain(CheckExternalScripts, /settings/external scripts/scripts/sample)¶DOMAIN
The user to run the command asAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: domain
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # DOMAIN domain=
encoding(CheckExternalScripts, /settings/external scripts/scripts/sample)¶ENCODING
The encoding to parse the command asAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: encoding
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # ENCODING encoding=
ignore perfdata(CheckExternalScripts, /settings/external scripts/scripts/sample)¶IGNORE PERF DATA
Do not parse performance data from the outputPath: /settings/external scripts/scripts/sample
Key: ignore perfdata
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # IGNORE PERF DATA ignore perfdata=0
is template(CheckExternalScripts, /settings/external scripts/scripts/sample)¶IS TEMPLATE
Declare this object as a template (this means it will not be available as a separate object)Advanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: is template
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # IS TEMPLATE is template=0
parent(CheckExternalScripts, /settings/external scripts/scripts/sample)¶PARENT
The parent the target inherits fromAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: parent
Default value: default
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # PARENT parent=default
password(CheckExternalScripts, /settings/external scripts/scripts/sample)¶PASSWORD
The user to run the command asAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: password
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # PASSWORD password=
user(CheckExternalScripts, /settings/external scripts/scripts/sample)¶USER
The user to run the command asAdvanced (means it is not commonly used)
Path: /settings/external scripts/scripts/sample
Key: user
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/scripts/sample] # USER user=
/settings/external scripts/wrapped scripts (CheckExternalScripts)¶WRAPPED SCRIPTS SECTION
A list of wrapped scripts (ie. scruts using a template mechanism). The template used will be defined by the extension of the script.Sample:
# WRAPPED SCRIPTS SECTION # A list of wrapped scripts (ie. scruts using a template mechanism). The template used will be defined by the extension of the script. [/settings/external scripts/wrapped scripts]
/settings/external scripts/wrappings (CheckExternalScripts)¶EXTERNAL SCRIPT WRAPPINGS SECTION
A list of templates for wrapped scripts.%SCRIPT% will be replaced by the actual script an %ARGS% will be replaced by any given arguments.
Key Default Value Description batBATCH FILE WRAPPING ps1POWERSHELL WRAPPING vbsVISUAL BASIC WRAPPING Sample:
# EXTERNAL SCRIPT WRAPPINGS SECTION # A list of templates for wrapped scripts. [/settings/external scripts/wrappings] bat= ps1= vbs=
bat(CheckExternalScripts, /settings/external scripts/wrappings)¶BATCH FILE WRAPPING
Path: /settings/external scripts/wrappings
Key: bat
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/wrappings] # BATCH FILE WRAPPING bat=
ps1(CheckExternalScripts, /settings/external scripts/wrappings)¶POWERSHELL WRAPPING
Path: /settings/external scripts/wrappings
Key: ps1
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/wrappings] # POWERSHELL WRAPPING ps1=
vbs(CheckExternalScripts, /settings/external scripts/wrappings)¶VISUAL BASIC WRAPPING
Path: /settings/external scripts/wrappings
Key: vbs
Default value:
Used by:
CheckExternalScriptsSample:
[/settings/external scripts/wrappings] # VISUAL BASIC WRAPPING vbs=