CheckExternalScripts
Execute external scripts

CheckExternalScripts — 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:

Path / Section Key Description
/settings/external scripts allow arguments COMMAND ARGUMENT PROCESSING
/settings/external scripts allow nasty characters COMMAND ALLOW NASTY META CHARS
/settings/external scripts script path SCRIPT DIRECTORY
/settings/external scripts timeout COMMAND TIMEOUT
/settings/external scripts/alias alias_cpu alias_cpu
/settings/external scripts/alias alias_cpu_ex alias_cpu_ex
/settings/external scripts/alias alias_disk alias_disk
/settings/external scripts/alias alias_disk_loose alias_disk_loose
/settings/external scripts/alias alias_event_log alias_event_log
/settings/external scripts/alias alias_file_age alias_file_age
/settings/external scripts/alias alias_file_size alias_file_size
/settings/external scripts/alias alias_mem alias_mem
/settings/external scripts/alias alias_process alias_process
/settings/external scripts/alias alias_process_count alias_process_count
/settings/external scripts/alias alias_process_hung alias_process_hung
/settings/external scripts/alias alias_process_stopped alias_process_stopped
/settings/external scripts/alias alias_sched_all alias_sched_all
/settings/external scripts/alias alias_sched_long alias_sched_long
/settings/external scripts/alias alias_sched_task alias_sched_task
/settings/external scripts/alias alias_service alias_service
/settings/external scripts/alias alias_service_ex alias_service_ex
/settings/external scripts/alias alias_up alias_up
/settings/external scripts/alias alias_volumes alias_volumes
/settings/external scripts/alias alias_volumes_loose alias_volumes_loose
/settings/external scripts/alias/default command COMMAND
/settings/external scripts/scripts/default command COMMAND
/settings/external scripts/scripts/default ignore perfdata IGNORE PERF DATA
/settings/external scripts/wrappings bat BATCH FILE WRAPPING
/settings/external scripts/wrappings ps1 POWERSHELL WRAPPING
/settings/external scripts/wrappings vbs VISUAL BASIC WRAPPING

Advanced keys:

Path / Section Key Default Value Description
/settings/external scripts/alias/default alias ALIAS  
/settings/external scripts/alias/default is template IS TEMPLATE  
/settings/external scripts/alias/default parent PARENT  
/settings/external scripts/alias/sample alias ALIAS  
/settings/external scripts/alias/sample is template IS TEMPLATE  
/settings/external scripts/alias/sample parent PARENT  
/settings/external scripts/scripts/default alias ALIAS  
/settings/external scripts/scripts/default capture output CAPTURE OUTPUT  
/settings/external scripts/scripts/default display DISPLAY  
/settings/external scripts/scripts/default domain DOMAIN  
/settings/external scripts/scripts/default encoding ENCODING  
/settings/external scripts/scripts/default is template IS TEMPLATE  
/settings/external scripts/scripts/default parent PARENT  
/settings/external scripts/scripts/default password PASSWORD  
/settings/external scripts/scripts/default session SESSION  
/settings/external scripts/scripts/default user USER  
/settings/external scripts/scripts/sample alias ALIAS  
/settings/external scripts/scripts/sample is template IS TEMPLATE  
/settings/external scripts/scripts/sample parent PARENT  

Sample keys:

Path / Section Key Default Value Description
/settings/external scripts/alias/sample command COMMAND  
/settings/external scripts/scripts/sample capture output CAPTURE OUTPUT  
/settings/external scripts/scripts/sample command COMMAND  
/settings/external scripts/scripts/sample display DISPLAY  
/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 password PASSWORD  
/settings/external scripts/scripts/sample session SESSION  
/settings/external scripts/scripts/sample user USER  

Samples

Adding a simple script

Adding a script we ca use the short hand format:

[/settings/external scripts/scripts]
my_ok1 = scripts\check_ok.bat
my_ok2 = scripts\check_ok.bat

Or the long format:

[/settings/external scripts/scripts/my_ok1]
command = scripts\check_ok.bat

[/settings/external scripts/scripts/my_ok2]
command = scripts\check_ok.bat

There is no difference between the two formats. Both will add two new commands called my_ok1 and my_ok2 which in turn will execute the scriptscheck_ok.bat script. Thus for most cases the short hand is preferd (and most commonly used). The reason for the long format is when you need to customize your command. There are a number of options which can be set to customze the command: for instance which user should run the command. These cannot be set using the short format.

Using arguments

There are two ways to use arguments.

# Hardcoded into the command # Allowing argument-pass through

The first option (hard-coding them) is obviously the more secure option as a third party cannot provide his or her own arguments. But it adds to the maintenance burden as whenever you want to change an option you need to update the NSClient++ configuration (something which can be costly if you have many servers).

To allow argument pass-through you need to set:

[/settings/external scripts]
allow arguments = true

Please note when it comes to arguments they can (and often need to) be configured in two place. Once for the NRPE Server and once for CheckExternalScripts.

Running a command as a user

Running a command as a given user (to use elevated privileges for instance) you need to use the long format:

[/settings/external scripts/scripts/check_as_user]
command = scripts\check_ok.bat
user = Administrator
password = 1qflkasdhf7ejd8/kjhskjhk(/)"#

You can also specify a session and to show the output if you want to have the program visible:

[/settings/external scripts/scripts/annoy_users]
command = notepad.exe
session = 1
display = true

Programs “running forever”

Another use case of external scripts is to have event handlers which starts programs. This is trickier then it sounds because all commands have a timeout and once that is reach they are killed. NSClient++ exits it also terminates all running script thus your “fix” will not be very long. To work around this you need to start the program without the control of NSClient++ (fork). To do this you need to set capture output to false like so:

[/settings/external scripts/scripts/fix_problem]
command = notepad.exe
capture output = false

The draw back to this is that the script cannot return any output neither message nor status code.

A word of warning using “start” or other similar measure to try to start a program in a regular script will cause unexpected issue with NSClient++ due to how handles are inherited in Windows. This will end up blocking the port and forcing a restart of the server. Thus capture output = false method is preferred.

/ settings/ external scripts

/settings/external scripts (CheckExternalScripts)

EXTERNAL SCRIPT SECTION

Section for external scripts configuration options (CheckExternalScripts).
Key Default Value Description
allow arguments 0 COMMAND ARGUMENT PROCESSING
allow nasty characters 0 COMMAND ALLOW NASTY META CHARS
script path   SCRIPT DIRECTORY
timeout 60 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: CheckExternalScripts

Sample:

[/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: CheckExternalScripts

Sample:

[/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: CheckExternalScripts

Sample:

[/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: CheckExternalScripts

Sample:

[/settings/external scripts]
# COMMAND TIMEOUT
timeout=60

… / alias

/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_cpu   alias_cpu
alias_cpu_ex   alias_cpu_ex
alias_disk   alias_disk
alias_disk_loose   alias_disk_loose
alias_event_log   alias_event_log
alias_file_age   alias_file_age
alias_file_size   alias_file_size
alias_mem   alias_mem
alias_process   alias_process
alias_process_count   alias_process_count
alias_process_hung   alias_process_hung
alias_process_stopped   alias_process_stopped
alias_sched_all   alias_sched_all
alias_sched_long   alias_sched_long
alias_sched_task   alias_sched_task
alias_service   alias_service
alias_service_ex   alias_service_ex
alias_up   alias_up
alias_volumes   alias_volumes
alias_volumes_loose   alias_volumes_loose

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=
alias_cpu (CheckExternalScripts, /settings/external scripts/alias)

alias_cpu

To configure this create a section under: /settings/external scripts/alias/alias_cpu

Path: /settings/external scripts/alias

Key: alias_cpu

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_cpu
alias_cpu=
alias_cpu_ex (CheckExternalScripts, /settings/external scripts/alias)

alias_cpu_ex

To configure this create a section under: /settings/external scripts/alias/alias_cpu_ex

Path: /settings/external scripts/alias

Key: alias_cpu_ex

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_cpu_ex
alias_cpu_ex=
alias_disk (CheckExternalScripts, /settings/external scripts/alias)

alias_disk

To configure this create a section under: /settings/external scripts/alias/alias_disk

Path: /settings/external scripts/alias

Key: alias_disk

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_disk
alias_disk=
alias_disk_loose (CheckExternalScripts, /settings/external scripts/alias)

alias_disk_loose

To configure this create a section under: /settings/external scripts/alias/alias_disk_loose

Path: /settings/external scripts/alias

Key: alias_disk_loose

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_disk_loose
alias_disk_loose=
alias_event_log (CheckExternalScripts, /settings/external scripts/alias)

alias_event_log

To configure this create a section under: /settings/external scripts/alias/alias_event_log

Path: /settings/external scripts/alias

Key: alias_event_log

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_event_log
alias_event_log=
alias_file_age (CheckExternalScripts, /settings/external scripts/alias)

alias_file_age

To configure this create a section under: /settings/external scripts/alias/alias_file_age

Path: /settings/external scripts/alias

Key: alias_file_age

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_file_age
alias_file_age=
alias_file_size (CheckExternalScripts, /settings/external scripts/alias)

alias_file_size

To configure this create a section under: /settings/external scripts/alias/alias_file_size

Path: /settings/external scripts/alias

Key: alias_file_size

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_file_size
alias_file_size=
alias_mem (CheckExternalScripts, /settings/external scripts/alias)

alias_mem

To configure this create a section under: /settings/external scripts/alias/alias_mem

Path: /settings/external scripts/alias

Key: alias_mem

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_mem
alias_mem=
alias_process (CheckExternalScripts, /settings/external scripts/alias)

alias_process

To configure this create a section under: /settings/external scripts/alias/alias_process

Path: /settings/external scripts/alias

Key: alias_process

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_process
alias_process=
alias_process_count (CheckExternalScripts, /settings/external scripts/alias)

alias_process_count

To configure this create a section under: /settings/external scripts/alias/alias_process_count

Path: /settings/external scripts/alias

Key: alias_process_count

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_process_count
alias_process_count=
alias_process_hung (CheckExternalScripts, /settings/external scripts/alias)

alias_process_hung

To configure this create a section under: /settings/external scripts/alias/alias_process_hung

Path: /settings/external scripts/alias

Key: alias_process_hung

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_process_hung
alias_process_hung=
alias_process_stopped (CheckExternalScripts, /settings/external scripts/alias)

alias_process_stopped

To configure this create a section under: /settings/external scripts/alias/alias_process_stopped

Path: /settings/external scripts/alias

Key: alias_process_stopped

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_process_stopped
alias_process_stopped=
alias_sched_all (CheckExternalScripts, /settings/external scripts/alias)

alias_sched_all

To configure this create a section under: /settings/external scripts/alias/alias_sched_all

Path: /settings/external scripts/alias

Key: alias_sched_all

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_sched_all
alias_sched_all=
alias_sched_long (CheckExternalScripts, /settings/external scripts/alias)

alias_sched_long

To configure this create a section under: /settings/external scripts/alias/alias_sched_long

Path: /settings/external scripts/alias

Key: alias_sched_long

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_sched_long
alias_sched_long=
alias_sched_task (CheckExternalScripts, /settings/external scripts/alias)

alias_sched_task

To configure this create a section under: /settings/external scripts/alias/alias_sched_task

Path: /settings/external scripts/alias

Key: alias_sched_task

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_sched_task
alias_sched_task=
alias_service (CheckExternalScripts, /settings/external scripts/alias)

alias_service

To configure this create a section under: /settings/external scripts/alias/alias_service

Path: /settings/external scripts/alias

Key: alias_service

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_service
alias_service=
alias_service_ex (CheckExternalScripts, /settings/external scripts/alias)

alias_service_ex

To configure this create a section under: /settings/external scripts/alias/alias_service_ex

Path: /settings/external scripts/alias

Key: alias_service_ex

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_service_ex
alias_service_ex=
alias_up (CheckExternalScripts, /settings/external scripts/alias)

alias_up

To configure this create a section under: /settings/external scripts/alias/alias_up

Path: /settings/external scripts/alias

Key: alias_up

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_up
alias_up=
alias_volumes (CheckExternalScripts, /settings/external scripts/alias)

alias_volumes

To configure this create a section under: /settings/external scripts/alias/alias_volumes

Path: /settings/external scripts/alias

Key: alias_volumes

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_volumes
alias_volumes=
alias_volumes_loose (CheckExternalScripts, /settings/external scripts/alias)

alias_volumes_loose

To configure this create a section under: /settings/external scripts/alias/alias_volumes_loose

Path: /settings/external scripts/alias

Key: alias_volumes_loose

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias]
# alias_volumes_loose
alias_volumes_loose=

… / alias / default

/settings/external scripts/alias/default (CheckExternalScripts)

ALIAS DEFENITION

Alias definition for: default
Key Default Value Description
alias   ALIAS
command   COMMAND
is template 0 IS TEMPLATE
parent default PARENT

Sample:

# ALIAS DEFENITION
# Alias definition for: default
[/settings/external scripts/alias/default]
alias=
command=
is template=0
parent=default
alias (CheckExternalScripts, /settings/external scripts/alias/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/external scripts/alias/default

Key: alias

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/default]
# ALIAS
alias=
command (CheckExternalScripts, /settings/external scripts/alias/default)

COMMAND

Command to execute

Path: /settings/external scripts/alias/default

Key: command

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/default]
# COMMAND
command=
is template (CheckExternalScripts, /settings/external scripts/alias/default)

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/default

Key: is template

Default value: 0

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/default]
# IS TEMPLATE
is template=0
parent (CheckExternalScripts, /settings/external scripts/alias/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/external scripts/alias/default

Key: parent

Default value: default

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/default]
# PARENT
parent=default

… / alias / sample

/settings/external scripts/alias/sample (CheckExternalScripts)

ALIAS DEFENITION

Alias definition for: sample
Key Default Value Description
alias   ALIAS
command   COMMAND
is template 0 IS TEMPLATE
parent default 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 server

Advanced (means it is not commonly used)

Path: /settings/external scripts/alias/sample

Key: alias

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/sample]
# ALIAS
alias=
command (CheckExternalScripts, /settings/external scripts/alias/sample)

COMMAND

Command to execute

Path: /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: CheckExternalScripts

Sample:

[/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

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/sample]
# IS TEMPLATE
is template=0
parent (CheckExternalScripts, /settings/external scripts/alias/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/external scripts/alias/sample

Key: parent

Default value: default

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/alias/sample]
# PARENT
parent=default

… / scripts

/settings/external scripts/scripts (CheckExternalScripts)

SCRIPT SECTION

A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>

Sample:

# SCRIPT SECTION
# A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>
[/settings/external scripts/scripts]

… / scripts / default

/settings/external scripts/scripts/default (CheckExternalScripts)

COMMAND DEFENITION

Command definition for: default
Key Default Value Description
alias   ALIAS
capture output 0 CAPTURE OUTPUT
command   COMMAND
display 0 DISPLAY
domain   DOMAIN
encoding   ENCODING
ignore perfdata 0 IGNORE PERF DATA
is template 0 IS TEMPLATE
parent default PARENT
password   PASSWORD
session   SESSION
user   USER

Sample:

# COMMAND DEFENITION
# Command definition for: default
[/settings/external scripts/scripts/default]
alias=
capture output=0
command=
display=0
domain=
encoding=
ignore perfdata=0
is template=0
parent=default
password=
session=
user=
alias (CheckExternalScripts, /settings/external scripts/scripts/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: alias

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# ALIAS
alias=
capture output (CheckExternalScripts, /settings/external scripts/scripts/default)

CAPTURE OUTPUT

This should be set to false if you want to run commands which never terminates (i.e. relinquish control from NSClient++). The effect of this is that the command output will not be captured. The main use is to protect from socket reuse issues

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: capture output

Default value: 0

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# CAPTURE OUTPUT
capture output=0
command (CheckExternalScripts, /settings/external scripts/scripts/default)

COMMAND

Command to execute

Path: /settings/external scripts/scripts/default

Key: command

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# COMMAND
command=
display (CheckExternalScripts, /settings/external scripts/scripts/default)

DISPLAY

Set to true if you want to display the resulting window or not

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: display

Default value: 0

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# DISPLAY
display=0
domain (CheckExternalScripts, /settings/external scripts/scripts/default)

DOMAIN

The user to run the command as

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: domain

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# DOMAIN
domain=
encoding (CheckExternalScripts, /settings/external scripts/scripts/default)

ENCODING

The encoding to parse the command as

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: encoding

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# ENCODING
encoding=
ignore perfdata (CheckExternalScripts, /settings/external scripts/scripts/default)

IGNORE PERF DATA

Do not parse performance data from the output

Path: /settings/external scripts/scripts/default

Key: ignore perfdata

Default value: 0

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# IGNORE PERF DATA
ignore perfdata=0
is template (CheckExternalScripts, /settings/external scripts/scripts/default)

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/default

Key: is template

Default value: 0

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# IS TEMPLATE
is template=0
parent (CheckExternalScripts, /settings/external scripts/scripts/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: parent

Default value: default

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# PARENT
parent=default
password (CheckExternalScripts, /settings/external scripts/scripts/default)

PASSWORD

The user to run the command as

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: password

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# PASSWORD
password=
session (CheckExternalScripts, /settings/external scripts/scripts/default)

SESSION

Session you want to invoke the client in either the number of current for the one with a UI

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: session

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# SESSION
session=
user (CheckExternalScripts, /settings/external scripts/scripts/default)

USER

The user to run the command as

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/default

Key: user

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/default]
# USER
user=

… / scripts / sample

/settings/external scripts/scripts/sample (CheckExternalScripts)

COMMAND DEFENITION

Command definition for: sample
Key Default Value Description
alias   ALIAS
capture output 0 CAPTURE OUTPUT
command   COMMAND
display 0 DISPLAY
domain   DOMAIN
encoding   ENCODING
ignore perfdata 0 IGNORE PERF DATA
is template 0 IS TEMPLATE
parent default PARENT
password   PASSWORD
session   SESSION
user   USER

Sample:

# COMMAND DEFENITION
# Command definition for: sample
[/settings/external scripts/scripts/sample]
alias=
capture output=0
command=
display=0
domain=
encoding=
ignore perfdata=0
is template=0
parent=default
password=
session=
user=
alias (CheckExternalScripts, /settings/external scripts/scripts/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/sample

Key: alias

Default value:

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# ALIAS
alias=
capture output (CheckExternalScripts, /settings/external scripts/scripts/sample)

CAPTURE OUTPUT

This should be set to false if you want to run commands which never terminates (i.e. relinquish control from NSClient++). The effect of this is that the command output will not be captured. The main use is to protect from socket reuse issues

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/sample

Key: capture output

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# CAPTURE OUTPUT
capture output=0
command (CheckExternalScripts, /settings/external scripts/scripts/sample)

COMMAND

Command to execute

Path: /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: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# COMMAND
command=
display (CheckExternalScripts, /settings/external scripts/scripts/sample)

DISPLAY

Set to true if you want to display the resulting window or not

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/sample

Key: display

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# DISPLAY
display=0
domain (CheckExternalScripts, /settings/external scripts/scripts/sample)

DOMAIN

The user to run the command as

Advanced (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: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# DOMAIN
domain=
encoding (CheckExternalScripts, /settings/external scripts/scripts/sample)

ENCODING

The encoding to parse the command as

Advanced (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: CheckExternalScripts

Sample:

[/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 output

Path: /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: CheckExternalScripts

Sample:

[/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

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# IS TEMPLATE
is template=0
parent (CheckExternalScripts, /settings/external scripts/scripts/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/sample

Key: parent

Default value: default

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# PARENT
parent=default
password (CheckExternalScripts, /settings/external scripts/scripts/sample)

PASSWORD

The user to run the command as

Advanced (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: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# PASSWORD
password=
session (CheckExternalScripts, /settings/external scripts/scripts/sample)

SESSION

Session you want to invoke the client in either the number of current for the one with a UI

Advanced (means it is not commonly used)

Path: /settings/external scripts/scripts/sample

Key: session

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# SESSION
session=
user (CheckExternalScripts, /settings/external scripts/scripts/sample)

USER

The user to run the command as

Advanced (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: CheckExternalScripts

Sample:

[/settings/external scripts/scripts/sample]
# USER
user=

… / wrapped scripts

/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]

… / wrappings

/settings/external scripts/wrappings (CheckExternalScripts)

in flight

TODO
Key Default Value Description
bat   BATCH FILE WRAPPING
ps1   POWERSHELL WRAPPING
vbs   VISUAL BASIC WRAPPING

Sample:

# in flight
# TODO
[/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: :module:``, CheckExternalScripts

Sample:

[/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: :module:``, CheckExternalScripts

Sample:

[/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: :module:``, CheckExternalScripts

Sample:

[/settings/external scripts/wrappings]
# VISUAL BASIC WRAPPING
vbs=
comments powered by Disqus