added some more documentation around event-logs

Author: allmightyspiff

SoftLayer/CLI/call_api.py

@@ -87,19 +87,19 @@ def cli(env, service, method, parameters, _id, _filters, mask, limit, offset,
         output_python=False):
     """Call arbitrary API endpoints with the given SERVICE and METHOD.
 
-    \b
-    Examples:
-    slcli call-api Account getObject
-    slcli call-api Account getVirtualGuests --limit=10 --mask=id,hostname
-    slcli call-api Virtual_Guest getObject --id=12345
-    slcli call-api Metric_Tracking_Object getBandwidthData --id=1234 \\
-        "2015-01-01 00:00:00" "2015-01-1 12:00:00" public
-    slcli call-api Account getVirtualGuests \\
-        -f 'virtualGuests.datacenter.name=dal05' \\
-        -f 'virtualGuests.maxCpu=4' \\
-        --mask=id,hostname,datacenter.name,maxCpu
-    slcli call-api Account getVirtualGuests \\
-        -f 'virtualGuests.datacenter.name IN dal05,sng01'
+    Example::
+
+        slcli call-api Account getObject
+        slcli call-api Account getVirtualGuests --limit=10 --mask=id,hostname
+        slcli call-api Virtual_Guest getObject --id=12345
+        slcli call-api Metric_Tracking_Object getBandwidthData --id=1234 \\
+            "2015-01-01 00:00:00" "2015-01-1 12:00:00" public
+        slcli call-api Account getVirtualGuests \\
+            -f 'virtualGuests.datacenter.name=dal05' \\
+            -f 'virtualGuests.maxCpu=4' \\
+            --mask=id,hostname,datacenter.name,maxCpu
+        slcli call-api Account getVirtualGuests \\
+            -f 'virtualGuests.datacenter.name IN dal05,sng01'
     """
 
     args = [service, method] + list(parameters)

SoftLayer/CLI/event_log/get.py

@@ -27,7 +27,11 @@
               help="Total number of result to return. -1 to return ALL, there may be a LOT of these.")
 @environment.pass_env
 def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metadata, limit):
-    """Get Event Logs"""
+    """Get Event Logs
+
+    Example:
+        slcli event-log get -d 01/01/2019 -D 02/01/2019 -t User -l 10
+    """
     columns = ['Event', 'Object', 'Type', 'Date', 'Username']
 
     event_mgr = SoftLayer.EventLogManager(env.client)

SoftLayer/managers/event_log.py

@@ -1,6 +1,6 @@
 """
     SoftLayer.event_log
-    ~~~~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~~~~
     Network Manager/helpers
 
     :license: MIT, see LICENSE for more details.
@@ -23,11 +23,20 @@ def __init__(self, client):
     def get_event_logs(self, request_filter=None, log_limit=20, iterator=True):
         """Returns a list of event logs
 
+        Example::
+
+            event_mgr = SoftLayer.EventLogManager(env.client)
+            request_filter = event_mgr.build_filter(date_min="01/01/2019", date_max="02/01/2019")
+            logs = event_mgr.get_event_logs(request_filter)
+            for log in logs:
+                print("Event Name: {}".format(log['eventName']))
+
+
         :param dict request_filter: filter dict
         :param int log_limit: number of results to get in one API call
         :param bool iterator: False will only make one API call for log_limit results.
             True will keep making API calls until all logs have been retreived. There may be a lot of these.
-        :returns: List of event logs
+        :returns: List of event logs. If iterator=True, will return a python generator object instead.
         """
         if iterator:
             # Call iter_call directly as this returns the actual generator

docs/api/managers/event_log.rst

@@ -0,0 +1,5 @@
+.. _event_log:
+
+.. automodule:: SoftLayer.managers.event_log
+   :members:
+   :inherited-members:

docs/cli.rst

@@ -11,13 +11,9 @@ functionality not fully documented here.
 
 .. toctree::
    :maxdepth: 2
+   :glob:
 
-   cli/account
-   cli/vs
-   cli/hardware
-   cli/ordering
-   cli/users
-   cli/ipsec
+   cli/*
 
 .. _config_setup:
 
@@ -179,3 +175,4 @@ Most commands will take in additional options/arguments. To see all available ac
 	  --tags TEXT                     Show instances that have one of these comma-
 	                                  separated tags
 	  --help                          Show this message and exit.
+

docs/cli/call_api.rst

@@ -0,0 +1,9 @@
+.. _cli_call_api:
+
+Call API
+========
+
+
+.. click:: SoftLayer.CLI.call_api:cli
+    :prog: call-api
+    :show-nested:

docs/cli/event_log.rst

@@ -0,0 +1,36 @@
+.. _cli_event_log:
+
+Event-Log Commands
+====================
+
+
+.. click:: SoftLayer.CLI.event_log.get:cli
+    :prog: event-log get
+    :show-nested:
+
+There are usually quite a few events on an account, so be careful when using the `--limit -1` option. The command will automatically break requests out into smaller sub-requests, but this command may take a very long time to complete. It will however print out data as it comes in.
+
+.. click:: SoftLayer.CLI.event_log.types:cli
+    :prog: event-log types
+    :show-nested:
+
+
+Currently the types are as follows, more may be added in the future.
+::
+    
+    :......................:
+    :        types         :
+    :......................:
+    :       Account        :
+    :         CDN          :
+    :         User         :
+    : Bare Metal Instance  :
+    :  API Authentication  :
+    :        Server        :
+    :         CCI          :
+    :        Image         :
+    :      Bluemix LB      :
+    :       Facility       :
+    : Cloud Object Storage :
+    :    Security Group    :
+    :......................: