From aa81d8871e6d222db03623a7e31f63050803839c Mon Sep 17 00:00:00 2001 From: <> Date: Sun, 19 Nov 2023 11:56:52 +0000 Subject: [PATCH] Deployed 349742f with MkDocs version: 1.5.3 --- .nojekyll | 0 404.html | 758 ++ acl/index.html | 2005 +++++ assets/_mkdocstrings.css | 64 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.dff1b7c8.min.js | 29 + assets/javascripts/bundle.dff1b7c8.min.js.map | 8 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 ++++++++++++++ .../workers/search.dfff1995.min.js | 42 + .../workers/search.dfff1995.min.js.map | 8 + assets/stylesheets/main.046329b4.min.css | 1 + assets/stylesheets/main.046329b4.min.css.map | 1 + assets/stylesheets/palette.85d0ee34.min.css | 1 + .../stylesheets/palette.85d0ee34.min.css.map | 1 + conf_manager/index.html | 4236 +++++++++ credentials/index.html | 2982 +++++++ file_monitor/index.html | 1726 ++++ hec_config/index.html | 2293 +++++ index.html | 791 ++ log/index.html | 2132 +++++ modular_input/checkpointer/index.html | 2916 +++++++ modular_input/event/index.html | 2482 ++++++ modular_input/event_writer/index.html | 4284 +++++++++ modular_input/modular_input/index.html | 3800 ++++++++ net_utils/index.html | 1696 ++++ objects.inv | Bin 0 -> 2693 bytes orphan_process_monitor/index.html | 1673 ++++ pattern/index.html | 1091 +++ search/search_index.json | 1 + server_info/index.html | 2860 ++++++ sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes splunk_rest_client/index.html | 1394 +++ splunkenv/index.html | 2017 +++++ time_parser/index.html | 1977 +++++ timer_queue/index.html | 3267 +++++++ user_access/index.html | 7738 +++++++++++++++++ utils/index.html | 1764 ++++ 70 files changed, 63241 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 acl/index.html create mode 100644 assets/_mkdocstrings.css create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.dff1b7c8.min.js create mode 100644 assets/javascripts/bundle.dff1b7c8.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.dfff1995.min.js create mode 100644 assets/javascripts/workers/search.dfff1995.min.js.map create mode 100644 assets/stylesheets/main.046329b4.min.css create mode 100644 assets/stylesheets/main.046329b4.min.css.map create mode 100644 assets/stylesheets/palette.85d0ee34.min.css create mode 100644 assets/stylesheets/palette.85d0ee34.min.css.map create mode 100644 conf_manager/index.html create mode 100644 credentials/index.html create mode 100644 file_monitor/index.html create mode 100644 hec_config/index.html create mode 100644 index.html create mode 100644 log/index.html create mode 100644 modular_input/checkpointer/index.html create mode 100644 modular_input/event/index.html create mode 100644 modular_input/event_writer/index.html create mode 100644 modular_input/modular_input/index.html create mode 100644 net_utils/index.html create mode 100644 objects.inv create mode 100644 orphan_process_monitor/index.html create mode 100644 pattern/index.html create mode 100644 search/search_index.json create mode 100644 server_info/index.html create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 splunk_rest_client/index.html create mode 100644 splunkenv/index.html create mode 100644 time_parser/index.html create mode 100644 timer_queue/index.html create mode 100644 user_access/index.html create mode 100644 utils/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..646bc587 --- /dev/null +++ b/404.html @@ -0,0 +1,758 @@ + + + +
+ + + + + + + + + + + + + + +This module contains interfaces that support CRUD operations on ACL.
+ + + +__all__ = ['ACLException', 'ACLManager']
+
+
+ module-attribute
+
+
+¶ACLException
+
+
+¶
+ Bases: Exception
Exception raised by ACLManager.
+ + +solnlib/acl.py
30 +31 +32 +33 |
|
ACLManager
+
+
+¶ACL manager.
+ +Examples:
+>>> import solnlib.acl as sacl
+>>> saclm = sacl.ACLManager(session_key, 'Splunk_TA_test')
+>>> saclm.get('data/transforms/extractions')
+>>> saclm.update('data/transforms/extractions/_acl',
+ perms_read=['*'], perms_write=['*'])
+
solnlib/acl.py
36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 |
|
__init__(session_key, app, owner='nobody', scheme=None, host=None, port=None, **context)
+
+¶Initializes ACLManager.
+ +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
session_key |
+
+ str
+ |
+
+
+
+ Splunk access token. + |
+ + required + | +
app |
+
+ str
+ |
+
+
+
+ App name of namespace. + |
+ + required + | +
owner |
+
+ str
+ |
+
+
+
+ (optional) Owner of namespace, default is |
+
+ 'nobody'
+ |
+
scheme |
+
+ str
+ |
+
+
+
+ (optional) The access scheme, default is None. + |
+
+ None
+ |
+
host |
+
+ str
+ |
+
+
+
+ (optional) The host name, default is None. + |
+
+ None
+ |
+
port |
+
+ int
+ |
+
+
+
+ (optional) The port number, default is None. + |
+
+ None
+ |
+
context |
+
+ dict
+ |
+
+
+
+ Other configurations for Splunk rest client. + |
+
+ {}
+ |
+
solnlib/acl.py
47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 |
|
get(path)
+
+¶Get ACL of /servicesNS/{owner
}/{app
}/{path
}.
Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
path |
+
+ str
+ |
+
+
+
+ Path of ACL relative to /servicesNS/{ |
+ + required + | +
Returns:
+Type | +Description | +
---|---|
+ dict
+ |
+
+
+
+ A dict contains ACL. + |
+
Raises:
+Type | +Description | +
---|---|
+ ACLException
+ |
+
+
+
+ If |
+
Examples:
+>>> aclm = acl.ACLManager(session_key, 'Splunk_TA_test')
+>>> perms = aclm.get('data/transforms/extractions/_acl')
+
solnlib/acl.py
78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 |
|
update(path, owner=None, perms_read=None, perms_write=None)
+
+¶Update ACL of /servicesNS/{owner
}/{app
}/{path
}.
If the ACL is per-entity (ends in /acl), owner can be reassigned. If +the acl is endpoint-level (ends in _acl), owner will be ignored. The +‘sharing’ setting is always retrieved from the current.
+ +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
path |
+
+ str
+ |
+
+
+
+ Path of ACL relative to /servicesNS/{owner}/{app}. MUST +end with /acl or /_acl indicating whether the permission is applied +at the per-entity level or endpoint level respectively. + |
+ + required + | +
owner |
+
+ str
+ |
+
+
+
+ (optional) New owner of ACL, default is |
+
+ None
+ |
+
perms_read |
+
+ List
+ |
+
+
+
+ (optional) List of roles ([‘*’] for all roles). If +unspecified we will POST with current (if available) perms.read, +default is None. + |
+
+ None
+ |
+
perms_write |
+
+ List
+ |
+
+
+
+ (optional) List of roles ([‘*’] for all roles). If +unspecified we will POST with current (if available) perms.write, +default is None. + |
+
+ None
+ |
+
Returns:
+Type | +Description | +
---|---|
+ dict
+ |
+
+
+
+ A dict contains ACL after update. + |
+
Raises:
+Type | +Description | +
---|---|
+ ACLException
+ |
+
+
+
+ If |
+
Examples:
+>>> aclm = acl.ACLManager(session_key, 'Splunk_TA_test')
+>>> perms = aclm.update('data/transforms/extractions/_acl',
+ perms_read=['admin'], perms_write=['admin'])
+
solnlib/acl.py
106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 |
|
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var _a=/["'&<>]/;Pn.exports=Aa;function Aa(e){var t=""+e,r=_a.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i