Op5Client
Client for connecting nativly to the Op5 Nortbound API
Enable module
To enable this module and and allow using the commands you need to ass Op5Client = enabled to the [/modules] section in nsclient.ini:
[/modules]
Op5Client = enabled
Configuration
| Path / Section | Description |
|---|---|
| /settings/op5 | Op5 Configuration |
| /settings/op5/checks | Op5 passive Commands |
Op5 Configuration
Section for the Op5 server
| Key | Default Value | Description |
|---|---|---|
| channel | op5 | CHANNEL |
| contactgroups | Contact groups | |
| default checks | true | Install default checks |
| hostgroups | Host groups | |
| hostname | auto | HOSTNAME |
| interval | 5m | Check interval |
| password | Op5 password | |
| remove | false | Remove checks on exit |
| server | Op5 base url | |
| user | Op5 user |
# Section for the Op5 server
[/settings/op5]
channel=op5
default checks=true
hostname=auto
interval=5m
remove=false
CHANNEL
The channel to listen to.
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | channel |
| Default value: | op5 |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# CHANNEL
channel=op5
Contact groups
A coma separated list of contact groups to add to this host when registering it in monitor
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | contactgroups |
| Default value: | N/A |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Contact groups
contactgroups=
Install default checks
Set to false to disable default checks
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | default checks |
| Default value: | true |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Install default checks
default checks=true
Host groups
A coma separated list of host groups to add to this host when registering it in monitor
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | hostgroups |
| Default value: | N/A |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Host groups
hostgroups=
HOSTNAME
The host name of this monitored computer. Set this to auto (default) to use the windows name of the computer.
auto Hostname ${host} Hostname ${host_lc} Hostname in lowercase ${host_uc} Hostname in uppercase ${domain} Domainname ${domain_lc} Domainname in lowercase ${domain_uc} Domainname in uppercase
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | hostname |
| Default value: | auto |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# HOSTNAME
hostname=auto
Check interval
How often to submit passive check results you can use an optional suffix to denote time (s, m, h)
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | interval |
| Default value: | 5m |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Check interval
interval=5m
Op5 password
The password for the user to authenticate as
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | password |
| Default value: | N/A |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Op5 password
password=
Remove checks on exit
If we should remove all checks when NSClient++ shuts down (for truly elastic scenarios)
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | remove |
| Default value: | false |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Remove checks on exit
remove=false
Op5 base url
The op5 base url i.e. the url of the Op5 monitor REST API for instance https://monitor.mycompany.com
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | server |
| Default value: | N/A |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Op5 base url
server=
Op5 user
The user to authenticate as
| Key | Description |
|---|---|
| Path: | /settings/op5 |
| Key: | user |
| Default value: | N/A |
| Used by: | Op5Client |
Sample:
[/settings/op5]
# Op5 user
user=
Op5 passive Commands
This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.