Knowledge Management

How could I check for optional keywords and options in custom command?

grimlock
Path Finder

In building a custom command I am trying to validated the presence/absence of an option:

Sample code doing the assignment can be found below


results,dummyresults,settings = splunk.Intersplunk.getOrganizedResults()
field = options.get('field', None)

charsense = options.get('detect', None)

Very simply I want to assign none to charsense if the option is not present.
Conversely, I would like to NOT perform character detection if the value is not present.

Additionally, any way to present a usage to the user in the event they do not give either option would be beneficial.

Thank you very much, you guys and gals are always a huge help

Tags (1)
0 Karma
1 Solution

grimlock
Path Finder

Below is the code I ended up using:

For optional keywords:
detect = None
if 'detection' in keywords:
detect = True

For required keywords missing options:
if not options.has_key('field'):
output_result = splunk.Intersplunk.generateErrorResults("Error Message placed here")

View solution in original post

0 Karma

grimlock
Path Finder

Below is the code I ended up using:

For optional keywords:
detect = None
if 'detection' in keywords:
detect = True

For required keywords missing options:
if not options.has_key('field'):
output_result = splunk.Intersplunk.generateErrorResults("Error Message placed here")

0 Karma

DalJeanis
Legend

@grimlock - Thanks for posting your solution! Please accept your answer so the question will show as closed.

0 Karma
Get Updates on the Splunk Community!

Introducing the 2024 SplunkTrust!

Hello, Splunk Community! We are beyond thrilled to announce our newest group of SplunkTrust members!  The ...

Introducing the 2024 Splunk MVPs!

We are excited to announce the 2024 cohort of the Splunk MVP program. Splunk MVPs are passionate members of ...

Splunk Custom Visualizations App End of Life

The Splunk Custom Visualizations apps End of Life for SimpleXML will reach end of support on Dec 21, 2024, ...