From f6cd718888dc36a79b1878c9869e6f4ecfd630b4 Mon Sep 17 00:00:00 2001 From: Robert Sander Date: Tue, 13 Feb 2024 17:27:53 +0100 Subject: [PATCH] updates documentation --- check_mk_api/checkmkapi.html | 115 ++++++++++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 16 deletions(-) diff --git a/check_mk_api/checkmkapi.html b/check_mk_api/checkmkapi.html index cd98648c..2f6f676f 100644 --- a/check_mk_api/checkmkapi.html +++ b/check_mk_api/checkmkapi.html @@ -20,9 +20,10 @@ json
os
requests
-time
-warnings
-

+sys
+time
+warnings
+

@@ -103,6 +104,30 @@ Returns:
    (data, etag): usually both empty +
bulk_create_host_groups(self, entries={})
Bulk create host groups
+ 
+Args:
+   entries: Mapping of host group name to alias (title)
+ 
+Returns:
+  (list of host groups, etag)
+ +
bulk_delete_host_groups(self, entries=[])
Bulk delete host groups
+ 
+Args:
+   entries: list of host group names
+ 
+Returns:
+  None
+ +
bulk_edit_host_groups(self, entries={})
Bulk update host groups (change alias)
+ 
+Args:
+   entries: Mapping of host group name to alias (title)
+ 
+Returns:
+  (list of host groups, etag)
+
create_aux_tag(self, name, title, topic, help=None)
Create an auxiliary tag
 
Args:
@@ -135,6 +160,15 @@     data: folder's data
    etag: current etag value
+
create_host_group(self, name, title)
Create host group
+ 
+Args:
+    name: internal name of host group
+    title: human readable alias of host group
+ 
+Returns:
+    (host group, etag)
+
create_host_tag_group(self, name, title, tags, topic=None, help=None)
Create a host tag group
 
Args:
@@ -190,7 +224,13 @@ Args:
    name: The name of the contact group.
-
delete_folder(self, folder)
+
delete_folder(self, folder)
Delete a folder
+ 
+Args:
+    folder: Folder path
+ 
+Returns:
+    ({}, '')
delete_host(self, hostname)
Deletes a host from the CheckMK configuration.
 
@@ -202,6 +242,14 @@     data: host's data
    etag: current etag value
+
delete_host_group(self, name)
Delete a host group
+ 
+Args:
+    name: internal name of host group
+ 
+Returns:
+    None
+
delete_host_tag_group(self, name)
Delete a host tag group
 
Args:
@@ -235,7 +283,7 @@ Returns:
    Nothing
-
disc_host(self, hostname)
Discovers services on a host.
+
disc_host(self, hostname, mode='new')
Discovers services on a host.
 
Args:
    hostname: name of the host
@@ -245,6 +293,15 @@     data: discovery data
    etag: current etag value
+
download_agent(self, hostname, ostype)
Download agent package for a host
+ 
+Args:
+    hostname: name of the host
+    ostype: type of agent ("aix_tgz", "linux_deb", "linux_rpm", "linux_tgz", "solaris_pkg", "solaris_tgz" or "windows_msi")
+ 
+Returns:
+    filename, filecontent
+
edit_aux_tag(self, name, title=None, topic=None, help=None)
Update an auxiliary tag
 
Args:
@@ -257,7 +314,7 @@     auxiliary tag
    etag
-
edit_contactgroup(self, name, alias, etag=None)
Change the contact group's alias
+
edit_contactgroup(self, name, alias, etag='*')
Change the contact group's alias
 
Args:
    name: The name of the contact group.
@@ -300,6 +357,15 @@     data: host's data
    etag: current etag value
+
edit_host_group(self, name, title, etag='*')
Update a host group
+ 
+Args:
+    name: internal name of host group
+    title: human readable alias of host group
+ 
+Returns:
+    (host group, etag)
+
edit_host_tag_group(self, name, etag, title=None, topic=None, help=None, tags=[])
Update a host tag group
 
Args:
@@ -363,6 +429,15 @@     data: list of folders
    etag: current etag value
+
get_all_host_groups(self)
Show all host groups
+ 
+Args:
+    None
+ 
+Returns:
+    list of host groups
+    etag
+
get_all_hosts(self, effective_attr=False, attributes=True)
Gets all hosts from the CheckMK configuration.
 
Args:
@@ -372,6 +447,15 @@ Returns:
    hosts: Dictionary of host data or dict of hostname -> URL depending on aatributes parameter
+
get_all_notification_rules(self)
Show all notification rules
+ 
+Args:
+    None
+ 
+Returns:
+    list of notification rules
+    etag
+
get_aux_tag(self, name)
Show an auxiliary tag
 
Args:
@@ -420,6 +504,14 @@     data: host's data
    etag: current etag value
+
get_host_group(self, name)
Show a host group
+ 
+Args:
+    name: internal name of host group
+ 
+Returns:
+    (host group, etag)
+
get_host_tag_group(self, name)
Show a host tag group
 
Args:
@@ -447,15 +539,6 @@     notification rule
    etag
-
get_notification_rules(self)
Show all notification rules
- 
-Args:
-    None
- 
-Returns:
-    list of notification rules
-    etag
-
get_rules(self, ruleset_name)
Gets rules from ruleset by name
 
Args:
@@ -500,7 +583,7 @@ Returns:
    (data, etag): user object and eTag
-
move_folder(self, folder, destination, etag=None)
Moves a folder into a destination folder.
+
move_folder(self, folder, destination, etag='*')
Moves a folder into a destination folder.
 
Args:
    folder: The path of the folder being requested.
 
Classes