SMTPClient

Passive check support via SMTP

Queries (commands)

• smtp_query? Check remote SMTP host
• smtp_help? Help on using SMTP Client
• smtp_exec? Execute (via query) remote SMTP host
• smtp_submit Submit (via query) remote SMTP host
• smtp_forward? Forward query to remote SMTP host

Commands (executable)

TODO: Add command list

Configuration

REMOTE TARGET DEFINITIONS

Section: /settings/SMTP/client/targets

Sample:

# REMOTE TARGET DEFINITIONS
# 
[/settings/SMTP/client/targets]

CLIENT HANDLER SECTION

Section: /settings/SMTP/client/handlers

Sample:

# CLIENT HANDLER SECTION
# 
[/settings/SMTP/client/handlers]

SMTP CLIENT SECTION

Section for SMTP passive check module.

Section: /settings/SMTP/client

Keys:

Key	Title	Description
channel	CHANNEL	The channel to listen to.

Sample:

# SMTP CLIENT SECTION
# Section for SMTP passive check module.
[/settings/SMTP/client]
# CHANNEL
# The channel to listen to.
channel=SMTP

CHANNEL

Description: The channel to listen to.

Key: channel

Default value: SMTP

Sample:

# CHANNEL
# The channel to listen to.
[/settings/SMTP/client]
channel=SMTP

TARGET DEFENITION

Target definition for: default

Section: /settings/SMTP/client/targets/default

Keys:

Key	Title	Description
sender	SENDER	Sender of email message
timeout	TIMEOUT	Timeout when reading/writing packets to/from sockets.
template	TEMPLATE	Template for message data
address	TARGET ADDRESS	Target host address
recipient	RECIPIENT	Recipient of email message

Advanced Keys:

Key	Title	Description
parent	TARGET PARENT	The parent the target inherits from
is template	IS TEMPLATE	Declare this object as a template (this means it will not be avalible as a separate object)
alias	TARGET ALIAS	The alias for the target
host	TARGET HOST	The target server to report results to.
port	TARGET PORT	The target server port

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/SMTP/client/targets/default]
# SENDER
# Sender of email message
sender=nscp@localhost
# TARGET PARENT
# The parent the target inherits from
parent=default
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# IS TEMPLATE
# Declare this object as a template (this means it will not be avalible as a separate object)
is template=0
# TARGET ALIAS
# The alias for the target
alias=default
# TARGET HOST
# The target server to report results to.
host=
# TEMPLATE
# Template for message data
template=Hello, this is %source% reporting %message%!
# TARGET ADDRESS
# Target host address
address=
# RECIPIENT
# Recipient of email message
recipient=nscp@localhost
# TARGET PORT
# The target server port
port=0

SENDER

Description: Sender of email message

Key: sender

Default value: nscp@localhost

Sample:

# SENDER
# Sender of email message
[/settings/SMTP/client/targets/default]
sender=nscp@localhost

TARGET PARENT

Description: The parent the target inherits from

Key: parent

Default value: default

Sample:

# TARGET PARENT
# The parent the target inherits from
[/settings/SMTP/client/targets/default]
parent=default

TIMEOUT

Description: Timeout when reading/writing packets to/from sockets.

Key: timeout

Default value: 30

Sample:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/SMTP/client/targets/default]
timeout=30

IS TEMPLATE

Description: Declare this object as a template (this means it will not be avalible as a separate object)

Key: is template

Default value: 0

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be avalible as a separate object)
[/settings/SMTP/client/targets/default]
is template=0

TARGET ALIAS

Description: The alias for the target

Key: alias

Default value: default

Sample:

# TARGET ALIAS
# The alias for the target
[/settings/SMTP/client/targets/default]
alias=default

TARGET HOST

Description: The target server to report results to.

Key: host

Sample:

# TARGET HOST
# The target server to report results to.
[/settings/SMTP/client/targets/default]
host=

TEMPLATE

Description: Template for message data

Key: template

Default value: Hello, this is %source% reporting %message%!

Sample:

# TEMPLATE
# Template for message data
[/settings/SMTP/client/targets/default]
template=Hello, this is %source% reporting %message%!

TARGET ADDRESS

Description: Target host address

Key: address

Sample:

# TARGET ADDRESS
# Target host address
[/settings/SMTP/client/targets/default]
address=

RECIPIENT

Description: Recipient of email message

Key: recipient

Default value: nscp@localhost

Sample:

# RECIPIENT
# Recipient of email message
[/settings/SMTP/client/targets/default]
recipient=nscp@localhost

TARGET PORT

Description: The target server port

Key: port

Default value: 0

Sample:

# TARGET PORT
# The target server port
[/settings/SMTP/client/targets/default]
port=0