package PB.Settings

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: SettingsRequestMessage.Request.Control

• DUMMY = 0

• LOAD = 1

• SAVE = 2

• RELOAD = 3

Used in: SettingsRequestMessage.Request.Registration, SettingsResponseMessage.Response.Inventory

• string title = 1

• string description = 2

• string icon = 10

• string default_value = 13

• bool advanced = 6

• bool sample = 7

• bool is_template = 11

• bool is_sensitive = 14

• string sample_usage = 8

• repeated string plugin = 9

• bool subkey = 12

• string type = 15

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. message Settings {

Used in: SettingsRequestMessage.Request.Diff, SettingsRequestMessage.Request.Inventory, SettingsRequestMessage.Request.Query, SettingsRequestMessage.Request.Registration, SettingsRequestMessage.Request.Update, SettingsResponseMessage.Response.Inventory, SettingsResponseMessage.Response.Query

• string path = 1

• string key = 2

• string value = 3

• optional Common.Header header = 1

• repeated SettingsRequestMessage.Request payload = 2

Used in: SettingsRequestMessage

• int64 id = 1

• int32 plugin_id = 3

• optional Request.Registration registration = 10

• optional Request.Query query = 11

• optional Request.Update update = 12

• optional Request.Inventory inventory = 13

• optional Request.Control control = 14

• optional Request.Status status = 15

• optional Request.Diff diff = 16

Used in: Request

• Command command = 1

• string context = 2

Used in: Request

• optional Node node = 1

• bool recursive = 2

Used in: Request

• string plugin = 11

• optional Node node = 1

• bool recursive_fetch = 2

• bool fetch_keys = 3

• bool fetch_paths = 4

• bool fetch_samples = 5

• bool fetch_templates = 7

• bool descriptions = 6

• bool redact_sensitive = 8

  See Query.redact_sensitive: mask values for sensitive keys.

Used in: Request

• optional Node node = 1

• bool recursive = 2

• bool include_keys = 6

• string default_value = 7

• bool redact_sensitive = 8

  When set, values for keys registered sensitive (add_password / is_sensitive_key) are returned as "***". Opt-in so internal self-reads (modules loading their own secrets) still get the real value; the REST read endpoints set it, nothing else does.

Used in: Request

• optional Node node = 1

• optional Information info = 2

• string fields = 3

Used in: Request

(message has no fields)

Used in: Request

• optional Node node = 1

• optional Common.Header header = 1

• repeated SettingsResponseMessage.Response payload = 2

Used in: SettingsResponseMessage

• int64 id = 1

• optional Common.Result result = 2

• optional Response.Registration registration = 10

• optional Response.Query query = 11

• optional Response.Update update = 12

• repeated Response.Inventory inventory = 13

• optional Response.Control control = 14

• optional Response.Status status = 15

• optional Response.Diff diff = 16

Used in: Response

(message has no fields)

Used in: Response

• repeated Diff.Entry entries = 1

Used in: Entry

• MODIFIED = 0

• ADDED = 1

• REMOVED = 2

• PATH_ADDED = 3

• PATH_REMOVED = 4

Used in: Diff

• string path = 1

• string key = 2

• string old_value = 3

• string new_value = 4

• ChangeType change_type = 5

• bool is_sensitive = 6

Used in: Response

• optional Node node = 1

• optional Information info = 2

Used in: Response

• optional Node node = 1

• repeated Node nodes = 3

Used in: Response

(message has no fields)

Used in: Response

• string context = 1

• string type = 2

• bool has_changed = 3

Used in: Response

(message has no fields)