Merge remote-tracking branch 'weiss/pr/3'
[nsca-ng.git] / python / README
blob51cbaac392b57a804c39ccc0c1ab704c26d20609
1 This is the `README` file of *python-nscang*.
3 Description
4 -----------
6 The Python NSCA-ng client allows for sending host or service check results
7 to NSCA-ng servers.
9 Examples
10 --------
12     from nscang import NSCAngNotifyer
14     n = NSCAngNotifyer(host="monitoring.example.com",
15                        port=5668,
16                        identity="foo.example.com",
17                        psk="secret")
19     n.svc_result(host_name="foo.example.com",
20                  svc_description="RAID status",
21                  return_code=0,
22                  plugin_output="OK: md126[raid1], md127[raid1]",
23                  timeout=5)