Plugin.
Common
¶Common utility types (re-used in various messages below)
ResultCode
¶A “nagios” status result.
Possible values | Id |
---|---|
OK | 0 |
WARNING | 1 |
CRITICAL | 2 |
UNKNOWN | 3 |
DataType
¶Type of data fields. @deprecated in favour of checking which field is available.
Possible values | Id |
---|---|
INT | 1 |
STRING | 2 |
FLOAT | 3 |
BOOL | 4 |
LIST | 5 |
Version
¶Main protocol version used @deprecated Makes very little sense and should be removed
Possible values | Id |
---|---|
VERSION_1 | 1 |
Nested messages
Plugin.Common.
AnyDataType
¶Data type used to wrap “any” primitive type. Used whenever the type can change.
string_data
¶A optional value of type string
String payload
int_data
¶A optional value of type int64
Numeric integer payload
float_data
¶A optional value of type double
Numeric floating point payload
bool_data
¶A optional value of type bool
Boolean (true/false) payload
list_data
¶A repeated value of type string
A string (multiple lines are separated by list entries @todo: remove repeated modifier from this field.
Plugin.Common.
Host
¶Field identifying a host entry
id
¶A optional value of type string
A unique identifier representing the host in this message
host
¶A optional value of type string
The host name
address
¶A optional value of type string
The address (usually the ip)
protocol
¶A optional value of type string
The protocol used to talk whit this host.
comment
¶A optional value of type string
A comment describing the host
metadata
¶A repeated value of type message
A key value store with attributes describing this host. The content and use of this attributes are application defined.
A repeated value of type string
A numer of tags defined for this host (can be used for routing purposes).
Plugin.Common.
Header
¶Header used in all messages. Contains basic information about the message.
version
¶A required value of type enum
Version of message. @ deprecated Not really useful
max_supported_version
¶A optional value of type enum
Maximmu supported version. Was planned to be used to negotiate version but was never used. @deprecated not used.
source_id
¶A optional value of type string
Source (sending) system. This is the system which sends the message (me).
sender_id
¶A optional value of type string
Sender is the original source of the message. THis is same as source unless message has been relayed.
recipient_id
¶A optional value of type string
Recipient is the final destination. This is the same as destination_id unless message is to be relayed.
destination_id
¶A optional value of type string
Destination (target) system. The system which will receive the message.
message_id
¶A optional value of type int64
Message identification. Has no meaning apart from identification. Set by source system and retained in any processing system.
metadata
¶A repeated value of type message
Meta data related to the message.
A repeated value of type string
A list of tags associated with the message.
hosts
¶A repeated value of type message
A list of hosts. All recipient/destination ids point to objects in this data set.
Plugin.Common.
Attachment
¶Attachment is used to attach information to another request. This is usually used to send along additional information not directly relatedt to the request. Or send unstructured data which is not supported by the original request.
id
¶A optional value of type int64
Identifier of attachment (for reference purpouses)
type
¶A required value of type string
The mime type for this attachment.
metadata
¶A repeated value of type message
Meta data related to the attachment.
A repeated value of type string
A list of tags associated with the attachment.
data
¶A required value of type string
The actual attachment (encoded)
Plugin.Common.
PerformanceData
¶alias
¶A required value of type string
type
¶A required value of type enum
int_value
¶A optional value of type message
string_value
¶A optional value of type message
float_value
¶A optional value of type message
bool_value
¶A optional value of type message
Nested messages
Plugin.
QueryRequestMessage
¶Query request
Used for querying the client this is the “normal” check_nrpe message request.
Associated response is Plugin.QueryResponseMessage
header
¶A required value of type message
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Nested messages
Plugin.QueryRequestMessage.
Request
¶id
¶A optional value of type int32
target
¶A optional value of type string
command
¶A required value of type string
alias
¶A optional value of type string
arguments
¶A repeated value of type string
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Plugin.
QueryResponseMessage
¶Query response
Used for querying the client this is the “normal” check_nrpe message request.
Associated request is Plugin.QueryRequestMessage
header
¶A required value of type message
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Nested messages
Plugin.QueryResponseMessage.
Response
¶id
¶A optional value of type int32
source
¶A optional value of type string
command
¶A required value of type string
alias
¶A optional value of type string
arguments
¶A repeated value of type string
result
¶A required value of type enum
message
¶A required value of type string
data
¶A optional value of type bytes
perf
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Plugin.
ExecuteRequestMessage
¶Execute command request and response.
Used for executing commands on clients similar to Plugin.QueryRequestMessage
but wont return nagios check data
Associated response is Plugin.ExecuteResponseMessage
header
¶A required value of type message
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Nested messages
Plugin.
ExecuteResponseMessage
¶header
¶A required value of type message
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Nested messages
Plugin.ExecuteResponseMessage.
Response
¶id
¶A optional value of type int32
command
¶A required value of type string
arguments
¶A repeated value of type string
result
¶A required value of type enum
message
¶A required value of type string
data
¶A optional value of type bytes
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Plugin.
SubmitRequestMessage
¶Submit result request message.
Used for submitting a passive check results.
The actual payload (Request) is a normal Plugin.QueryResponseMessage.Response
.
Associated response is Plugin.SubmitResponseMessage
header
¶A required value of type message
channel
¶A required value of type string
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Plugin.
SubmitResponseMessage
¶Submit result response message.
Response from submitting a passive check results.
Associated request is Plugin.SubmitRequestMessage
header
¶A required value of type message
payload
¶A repeated value of type message
attachments
¶A repeated value of type message
The attachment is used to attach additional free form information.
Nested messages
Plugin.
Registry
¶Registration is an internal message. It is not used to submit checks or query status instead it is used so register modules, plug-ins, command. As well as query for them. The registry is a central component inside NSClient++ and this is the way to interact with the registry.
ItemType
¶Possible values | Id |
---|---|
QUERY | 1 |
COMMAND | 2 |
HANDLER | 3 |
PLUGIN | 4 |
QUERY_ALIAS | 5 |
ROUTER | 6 |
MODULE | 7 |
SCHEDULE | 8 |
ALL | 99 |
Command
¶Possible values | Id |
---|---|
LOAD | 1 |
UNLOAD | 2 |
RELOAD | 3 |
Nested messages
Plugin.Registry.
Information
¶title
¶A optional value of type string
description
¶A optional value of type string
metadata
¶A repeated value of type message
min_version
¶A optional value of type string
max_version
¶A optional value of type string
advanced
¶A optional value of type bool
plugin
¶A repeated value of type string
Plugin.Registry.
ParameterDetail
¶name
¶A optional value of type string
default_value
¶A optional value of type string
required
¶A optional value of type bool
repeatable
¶A optional value of type bool
content_type
¶A optional value of type enum
short_description
¶A optional value of type string
long_description
¶A optional value of type string
keyword
¶A repeated value of type message
Plugin.
RegistryRequestMessage
¶header
¶A required value of type message
payload
¶A repeated value of type message
Nested messages
Plugin.RegistryRequestMessage.Request.
Registration
¶plugin_id
¶A optional value of type int32
type
¶A required value of type enum
name
¶A required value of type string
info
¶A optional value of type message
unregister
¶A optional value of type bool
alias
¶A repeated value of type string
schedule
¶A repeated value of type message
Plugin.
RegistryResponseMessage
¶header
¶A required value of type message
payload
¶A repeated value of type message
Nested messages
Plugin.
Settings
¶Settings is an internal message. It is not used to submit checks or query status instead it is used to interact with the settings store. The settings is a central component inside NSClient++ and this is the way to interact with it.
Command
¶Possible values | Id |
---|---|
LOAD | 1 |
SAVE | 2 |
RELOAD | 3 |
Nested messages
Plugin.Settings.
Information
¶title
¶A optional value of type string
description
¶A optional value of type string
default_value
¶A optional value of type message
min_version
¶A optional value of type string
max_version
¶A optional value of type string
advanced
¶A optional value of type bool
sample
¶A optional value of type bool
sample_usage
¶A optional value of type string
plugin
¶A repeated value of type string
Plugin.
SettingsRequestMessage
¶header
¶A required value of type message
payload
¶A repeated value of type message
Nested messages
Plugin.SettingsRequestMessage.
Request
¶id
¶A optional value of type int64
plugin_id
¶A required value of type int32
registration
¶A optional value of type message
query
¶A optional value of type message
update
¶A optional value of type message
inventory
¶A optional value of type message
control
¶A optional value of type message
status
¶A optional value of type message
Nested messages
Plugin.SettingsRequestMessage.Request.
Inventory
¶plugin
¶A optional value of type string
node
¶A optional value of type message
query
¶A optional value of type message
recursive_fetch
¶A optional value of type bool
fetch_keys
¶A optional value of type bool
fetch_paths
¶A optional value of type bool
fetch_samples
¶A optional value of type bool
descriptions
¶A optional value of type bool
Plugin.
SettingsResponseMessage
¶header
¶A required value of type message
payload
¶A repeated value of type message
Nested messages
Plugin.SettingsResponseMessage.
Response
¶id
¶A optional value of type int64
result
¶A required value of type message
registration
¶A optional value of type message
query
¶A optional value of type message
update
¶A optional value of type message
inventory
¶A repeated value of type message
control
¶A optional value of type message
status
¶A optional value of type message
Nested messages
Plugin.
LogEntry
¶LogEntry is used to log status information.
entry
¶A repeated value of type message
Nested messages
Plugin.LogEntry.
Entry
¶Level
¶Possible values | Id |
---|---|
LOG_DEBUG | 500 |
LOG_INFO | 150 |
LOG_WARNING | 50 |
LOG_ERROR | 10 |
LOG_CRITICAL | 1 |
level
¶A required value of type enum
sender
¶A optional value of type string
file
¶A optional value of type string
line
¶A optional value of type int32
message
¶A optional value of type string
date
¶A optional value of type int32