Module ImportFrom alias ImportFrom alias TryExcept body ImportFrom alias handlers ExceptHandler type NameLoad body ImportFrom alias ImportFrom alias alias ImportFrom alias ImportFrom alias alias ImportFrom alias alias alias alias ImportFrom alias ImportFrom alias ImportFrom alias alias ImportFrom alias ImportFrom alias alias ImportFrom alias alias alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Assign TupleStore AttributeStore NameLoad attr AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad Call NameLoad NameLoad attr Assign AttributeStore NameLoad attr Call NameLoad Assign AttributeStore NameLoad attr Call NameLoad If CompareNotIn Str NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str NameLoad Assign AttributeStore NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore BinOpAdd ListLoad AttributeLoad Call NameLoad NameLoad attr Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad Str attr ListComp NameLoad comprehension NameStore NameLoad CompareGt Call NameLoad NameLoad Num Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Assign TupleStore AttributeStore NameLoad attr AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad Call NameLoad NameLoad attr NameLoad Return decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body If CompareIs NameLoad NameLoad body Assign NameStore AttributeLoad NameLoad attr If CompareIs Call NameLoad NameLoad NameLoad body TryExcept body Assign NameStore SubscriptLoad NameLoad Index Call AttributeLoad NameLoad attr handlers ExceptHandler type NameLoad body Raise Call NameLoad BinOpMod Str NameLoad orelse TryExcept body Assign NameStore Call NameLoad NameLoad handlers ExceptHandler type NameLoad body Raise Call NameLoad BinOpMod Str NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Return decorator_list AttributeLoad NameLoad attr Assign NameStore Call NameLoad keyword Str keyword NameLoad keyword Call NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str If CompareIs AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr NameLoad Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareIsNot AttributeLoad NameLoad attr NameLoad body Return AttributeLoad NameLoad attr TryExcept body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str handlers ExceptHandler type NameLoad body Return NameLoad FunctionDef arguments args NameParam defaults body Return Call AttributeLoad IfExp CompareEq SubscriptLoad NameLoad Index Num Str SubscriptLoad NameLoad Slice Num NameLoad attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore Call NameLoad GeneratorExp TupleLoad NameLoad Call NameLoad NameLoad comprehension TupleStore NameStore NameStore Call NameLoad SubscriptLoad NameLoad Slice Num Num SubscriptLoad NameLoad Slice Num Num orelse If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr NameLoad orelse If CompareEq NameLoad Str body Assign NameStore NameLoad orelse TryExcept body Assign NameStore Call NameLoad NameLoad If Call AttributeLoad NameLoad attr body Assign NameStore Call NameLoad NameLoad handlers ExceptHandler type NameLoad body Pass Return NameLoad decorator_list With Call NameLoad NameLoad Str NameStore body ImportFrom alias Import alias Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword Str Assign NameStore ListComp Call NameLoad NameLoad comprehension NameStore Call AttributeLoad NameLoad attr Assign NameStore ListComp Call NameLoad NameLoad NameLoad comprehension TupleStore NameStore NameStore Call NameLoad NameLoad Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Str NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr NameLoad Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareIsNot AttributeLoad NameLoad attr NameLoad body Return AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr If CompareIs NameLoad NameLoad body Return NameLoad Assign NameStore Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr keyword NameLoad Assign AttributeStore NameLoad attr Call NameLoad keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Call AttributeLoad AttributeLoad NameLoad attr attr BinOpAdd Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Expr Call NameLoad Num decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str AttributeLoad Call NameLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad TryExcept body If BoolOpAnd CompareGtE Call NameLoad NameLoad Num CompareEq SubscriptLoad NameLoad Index Num Str body Assign TupleStore NameStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad keyword NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Assign AttributeStore NameLoad attr Call NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr keyword Str Expr Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr orelse If BoolOpAnd CompareGtE Call NameLoad NameLoad Num CompareEq SubscriptLoad NameLoad Index Num Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign TupleStore NameStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Assign AttributeStore NameLoad attr Call NameLoad NameLoad If AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str BinOpMod Str TupleLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad orelse Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Num Assign NameStore Call AttributeLoad Str attr AttributeLoad Call NameLoad NameLoad attr NameLoad Raise Call NameLoad NameLoad handlers ExceptHandler type NameLoad body Raise ExceptHandler body Import alias Import alias Assign TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad Assign NameStore NameLoad While CompareIsNot AttributeLoad NameLoad attr NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Assign NameStore AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr NameLoad NameLoad NameLoad Expr Call NameLoad Num Return decorator_list FunctionDef arguments args NameParam defaults body For NameStore NameLoad body Expr Yield NameLoad Return decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults vararg body Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Return decorator_list FunctionDef arguments args NameParam NameParam defaults vararg body Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Return decorator_list FunctionDef arguments args NameParam NameParam defaults vararg body Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Return decorator_list FunctionDef arguments args NameParam NameParam defaults vararg body Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults vararg body Import alias If CompareGt Call NameLoad NameLoad Num body Assign NameStore BinOpMod NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr ListLoad ListLoad ListLoad NameLoad ListLoad NameLoad decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad Str attr ListComp BinOpMod Str TupleLoad NameLoad Call NameLoad NameLoad NameLoad comprehension NameStore Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore Num FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore Num FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad Call NameLoad NameLoad attr decorator_list NameLoad Assign NameStore Str FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad AttributeLoad NameLoad attr attr For TupleStore NameStore NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr body If Call NameLoad AttributeLoad NameLoad attr NameLoad body Assign NameStore AttributeLoad NameLoad attr If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad Str attr NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str If CompareIs AttributeLoad NameLoad attr NameLoad body Assign NameStore Lambda arguments args NameParam defaults Call NameLoad NameLoad NameLoad Assign AttributeStore NameLoad attr Dict For TupleStore NameStore NameStore Call NameLoad NameLoad NameLoad body Assign NameStore BinOpAdd Str NameLoad If UnaryOpNot Call NameLoad NameLoad NameLoad body Assign NameStore NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad TupleLoad NameLoad NameLoad Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call NameLoad Str decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad ListComp TupleLoad NameLoad Call NameLoad NameLoad NameLoad comprehension NameStore Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad Call AttributeLoad Call AttributeLoad Call NameLoad NameLoad attr attr decorator_list Assign NameStore NameLoad decorator_list decorator_list
N/A __future__ absolute_import splunklib.client Service N/A N/A collections OrderedDict N/A N/A N/A ImportError N/A ordereddict OrderedDict logging _levelNames getLevelName inspect getmembers os environ path sys argv exit stdin stdout urlparse urlsplit xml.etree ElementTree N/A logging splunk_csv decorators Option validators Boolean Fieldname search_command_internals InputHeader MessagesHeader SearchCommandParser SearchCommand N/A object N/A N/A  Represents a custom search command.

     __init__ N/A N/A self N/A N/A N/A N/A N/A self logger N/A self _logging_configuration N/A N/A logging configure N/A N/A type self __name__ N/A N/A self input_header N/A InputHeader N/A N/A self messages N/A MessagesHeader N/A N/A SPLUNK_HOME environ N/A N/A N/A N/A N/A self logger warning SPLUNK_HOME environment variable is undefined.
If you are testing outside of Splunk, consider running under control of the Splunk CLI:
    splunk cmd %s
If you are running inside of Splunk, SPLUNK_HOME should be defined. Consider troubleshooting your installation. self N/A N/A self _default_logging_level N/A N/A self logger level N/A N/A self _configuration None N/A N/A self _fieldnames None N/A N/A self _option_view None N/A N/A self _output_file None N/A N/A self _search_results_info None N/A N/A self _service None N/A N/A self parser N/A SearchCommandParser N/A __repr__ N/A N/A self N/A N/A N/A N/A str self N/A __str__ N/A N/A self N/A N/A N/A values N/A N/A N/A N/A type self name N/A str N/A self options N/A self fieldnames N/A text N/A N/A join N/A value N/A value values N/A N/A len value 0 N/A text N/A logging_configuration N/A N/A self N/A N/A N/A  **Syntax:** logging_configuration=<path>

        **Description:** Loads an alternative logging configuration file for
        a command invocation. The logging configuration file must be in Python
        ConfigParser-format. Path names are relative to the app root directory.

         N/A N/A self _logging_configuration N/A Option logging_configuration N/A N/A self value N/A N/A N/A N/A N/A self logger N/A self _logging_configuration N/A N/A logging configure N/A N/A type self __name__ value N/A N/A N/A logging_configuration setter logging_level N/A N/A self N/A N/A N/A  **Syntax:** logging_level=[CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]

        **Description:** Sets the threshold for the logger of this command
        invocation. Logging messages less severe than `logging_level` will be
        ignored.

         N/A N/A getLevelName N/A N/A N/A self logger getEffectiveLevel N/A Option logging_level N/A N/A self value N/A N/A N/A N/A value None N/A N/A value N/A self _default_logging_level N/A N/A N/A type value str N/A N/A N/A N/A level N/A _levelNames N/A N/A N/A value upper N/A N/A N/A KeyError N/A N/A N/A ValueError N/A Unrecognized logging level: %s value N/A N/A N/A N/A level N/A int value N/A N/A N/A ValueError N/A N/A N/A ValueError N/A Unrecognized logging level: %s value N/A N/A N/A N/A self logger setLevel level N/A N/A N/A logging_level setter N/A show_configuration N/A Option doc 
        **Syntax:** show_configuration=<bool>

        **Description:** When `true`, reports command configuration in the
        messages header for this command invocation. Defaults to `false`.

         default False validate N/A Boolean configuration N/A N/A self N/A N/A N/A  Returns the configuration settings for this command.

         N/A N/A self _configuration N/A property fieldnames N/A N/A self N/A N/A N/A  Returns the fieldnames specified as argument to this command.

         N/A N/A self _fieldnames N/A property fieldnames N/A N/A self value N/A N/A N/A N/A self _fieldnames value N/A N/A fieldnames setter options N/A N/A self N/A N/A N/A  Returns the options specified as argument to this command.

         N/A N/A N/A self _option_view None N/A N/A N/A self _option_view N/A N/A Option View self N/A N/A self _option_view N/A property search_results_info N/A N/A self N/A N/A N/A  Returns the search results info for this command invocation or None.

        The search results info object is created from the search results info
        file associated with the command invocation. Splunk does not pass the
        location of this file by default. You must request it by specifying
        these configuration settings in commands.conf:

        .. code-block:: python
            enableheader=true
            requires_srinfo=true

        The :code:`enableheader` setting is :code:`true` by default. Hence, you
        need not set it. The :code:`requires_srinfo` setting is false by
        default. Hence, you must set it.

        :return: :class:`SearchResultsInfo`, if :code:`enableheader` and
            :code:`requires_srinfo` are both :code:`true`. Otherwise, if either
            :code:`enableheader` or :code:`requires_srinfo` are :code:`false`,
            a value of :code:`None` is returned.

         N/A N/A N/A self _search_results_info None N/A N/A N/A self _search_results_info N/A N/A N/A info_path N/A N/A self input_header N/A infoPath N/A N/A N/A KeyError N/A N/A None convert_field N/A N/A field N/A N/A N/A N/A N/A N/A N/A N/A field N/A 0 _ N/A field N/A 1 field replace . _ N/A convert_value N/A N/A field value N/A N/A N/A N/A field countMap N/A N/A split N/A N/A value split ; N/A value N/A dict N/A N/A key N/A int value N/A N/A key value N/A zip N/A split N/A 0 2 N/A split N/A 1 2 N/A N/A N/A field vix_families N/A N/A value N/A N/A ElementTree fromstring value N/A N/A N/A value N/A N/A value None N/A N/A N/A N/A value N/A float value N/A N/A N/A value is_integer N/A N/A value N/A int value N/A N/A N/A ValueError N/A N/A N/A value N/A N/A N/A open info_path rb f N/A collections namedtuple N/A csv N/A reader N/A N/A csv reader f dialect splunklib.searchcommands N/A fields N/A N/A convert_field x N/A x N/A N/A reader next N/A values N/A N/A convert_value f v N/A N/A f v N/A zip fields N/A N/A reader next N/A search_results_info_type N/A namedtuple SearchResultsInfo fields N/A N/A self _search_results_info N/A N/A search_results_info_type _make values N/A N/A self _search_results_info N/A property service N/A N/A self N/A N/A N/A  Returns a Splunk service object for this command invocation or None.

        The service object is created from the Splunkd URI and authentication
        token passed to the command invocation in the search results info file.
        This data is not passed to a command invocation by default. You must
        request it by specifying this pair of configuration settings in
        commands.conf:

           .. code-block:: python
               enableheader=true
               requires_srinfo=true

        The :code:`enableheader` setting is :code:`true` by default. Hence, you
        need not set it. The :code:`requires_srinfo` setting is false by
        default. Hence, you must set it.

        :return: :class:`splunklib.client.Service`, if :code:`enableheader` and
            :code:`requires_srinfo` are both :code:`true`. Otherwise, if either
            :code:`enableheader` or :code:`requires_srinfo` are :code:`false`,
            a value of :code:`None` is returned.

         N/A N/A N/A self _service None N/A N/A N/A self _service N/A info N/A self search_results_info N/A N/A info None N/A N/A None N/A splunkd N/A urlsplit N/A info splunkd_uri N/A info splunkd_protocol allow_fragments False N/A N/A self _service N/A Service scheme N/A splunkd scheme host N/A splunkd hostname port N/A splunkd port token N/A info auth_token app N/A info ppc_app N/A N/A self _service N/A property error_exit N/A N/A self error N/A N/A N/A N/A N/A N/A self logger error N/A Abnormal exit:  error N/A N/A N/A self write_error error N/A N/A exit 1 N/A process N/A N/A self args input_file output_file N/A argv stdin stdout N/A N/A  Processes search results as specified by command arguments.

        :param args: Sequence of command arguments
        :param input_file: Pipeline input file
        :param output_file: Pipeline output file

         N/A N/A N/A N/A self logger debug %s arguments: %s N/A N/A type self __name__ args N/A N/A self _configuration None N/A N/A self _output_file output_file N/A N/A N/A N/A N/A N/A len args 2 N/A N/A args N/A 1 __GETINFO__ N/A N/A N/A ConfigurationSettings operation args reader N/A N/A self _prepare args input_file None N/A N/A N/A N/A self parser parse args self N/A N/A self _configuration N/A ConfigurationSettings self N/A writer N/A N/A splunk_csv DictWriter output_file self N/A N/A N/A self configuration keys mv_delimiter , N/A N/A N/A writer writerow N/A N/A N/A self configuration items N/A N/A N/A N/A N/A len args 2 N/A N/A args N/A 1 __EXECUTE__ N/A N/A N/A N/A N/A self input_header read input_file N/A N/A ConfigurationSettings operation args reader N/A N/A self _prepare args input_file N/A N/A N/A N/A self parser parse args self N/A N/A self _configuration N/A ConfigurationSettings self N/A N/A self show_configuration N/A N/A N/A N/A N/A self messages append info_message N/A %s command configuration settings: %s N/A N/A self name N/A self _configuration N/A writer N/A N/A splunk_csv DictWriter output_file self N/A N/A N/A self _execute operation reader writer N/A N/A file_name N/A N/A path basename N/A args N/A 0 N/A message N/A N/A Command {0} appears to be statically configured and static configuration is unsupported by splunklib.searchcommands. Please ensure that default/commands.conf contains this stanza:
[{0}]
filename = {1}
supports_getinfo = true
supports_rawargs = true
outputheader = true format N/A N/A type self name file_name N/A N/A NotImplementedError message N/A N/A N/A SystemExit N/A N/A N/A N/A N/A traceback N/A sys N/A N/A error_type error_message error_traceback N/A N/A sys exc_info N/A N/A N/A N/A self logger error N/A N/A traceback format_exc error_traceback N/A origin error_traceback N/A N/A N/A origin tb_next None N/A N/A origin N/A origin tb_next N/A filename N/A N/A N/A origin tb_frame f_code co_filename N/A lineno N/A origin tb_lineno N/A N/A N/A self write_error %s at "%s", line %d : %s N/A error_type __name__ filename lineno error_message N/A N/A exit 1 N/A N/A records N/A N/A reader N/A N/A N/A record reader N/A N/A N/A record N/A N/A staticmethod write_debug N/A N/A self message N/A args N/A N/A N/A N/A self _write_message DEBUG message args N/A N/A write_error N/A N/A self message N/A args N/A N/A N/A N/A self _write_message ERROR message args N/A N/A write_info N/A N/A self message N/A args N/A N/A N/A N/A self _write_message INFO message args N/A N/A write_warning N/A N/A self message N/A args N/A N/A N/A N/A self _write_message WARN message args N/A _execute N/A N/A self operation reader writer N/A N/A N/A N/A NotImplementedError SearchCommand._configure(self, argv) N/A _prepare N/A N/A self argv input_file N/A N/A N/A N/A NotImplementedError SearchCommand._configure(self, argv) N/A _write_message N/A N/A self message_type message_text N/A args N/A N/A csv N/A N/A N/A len args 0 N/A N/A message_text N/A message_text args N/A writer N/A N/A csv writer N/A self _output_file N/A N/A N/A writer writerows N/A N/A N/A message_type N/A message_text N/A ConfigurationSettings N/A object N/A N/A  Represents the configuration settings common to all
        :class:`SearchCommand` classes.

         __init__ N/A N/A self command N/A N/A N/A N/A self command command N/A __str__ N/A N/A self N/A N/A N/A  Converts the value of this instance to its string representation.

            The value of this ConfigurationSettings instance is represented as a
            string of newline-separated :code:`name=value` pairs.

            :return: String representation of this instance

             N/A text N/A N/A ,  join N/A N/A %s=%s N/A k N/A getattr self k N/A k N/A N/A self keys N/A text N/A changes_colorder N/A N/A self N/A N/A N/A  Specifies whether output should be used to change the column
            ordering of fields.

            Default: :const:`True`

             N/A N/A N/A type self _changes_colorder N/A property N/A _changes_colorder True clear_required_fields N/A N/A self N/A N/A N/A  Specifies whether `required_fields` are the only fields required
            by subsequent commands.

            If :const:`True`, :attr:`required_fields` are the *only* fields
            required by subsequent commands. If :const:`False`,
            :attr:`required_fields` are additive to any fields that may be
            required by subsequent commands. In most cases :const:`False` is
            appropriate for streaming commands and :const:`True` is appropriate
            for reporting commands.

            Default: :const:`False`

             N/A N/A N/A type self _clear_required_fields N/A property N/A _clear_required_fields False enableheader N/A N/A self N/A N/A N/A  Signals that this command expects header information.

            Fixed: :const:`True`

             N/A True N/A property generating N/A N/A self N/A N/A N/A  Signals that this command does not generate new events.

            Fixed: :const:`False`

             N/A False N/A property maxinputs N/A N/A self N/A N/A N/A  Specifies the maximum number of events that may be passed to an
            invocation of this command.

            This limit may not exceed the value of `maxresultrows` as defined in
            limits.conf (default: 50,000). Use a value  of zero (0) to select a
            limit of `maxresultrows`.

            Default: :code:`0`

             N/A N/A N/A type self _maxinputs N/A property N/A _maxinputs 0 needs_empty_results N/A N/A self N/A N/A N/A  Specifies whether or not this search command must be called with
            intermediate empty search results.

            Default: :const:`True`

             N/A N/A N/A type self _needs_empty_results N/A property N/A _needs_empty_results True outputheader N/A N/A self N/A N/A N/A  Signals that the output of this command is a messages header
            followed by a blank line and splunk_csv search results.

            Fixed: :const:`True`

             N/A True N/A property passauth N/A N/A self N/A N/A N/A  Specifies whether or not this search command requires an
            authentication token on the start of input.

            Default: :const:`False`

             N/A N/A N/A type self _passauth N/A property N/A _passauth False perf_warn_limit N/A N/A self N/A N/A N/A  Tells Splunk to issue a performance warning message if more
            than this many input events are passed to this search command.

            A value of zero (0) disables performance warning messages.

            Default: :code:`0`

             N/A N/A N/A type self _perf_warn_limit N/A property N/A _perf_warn_limit 0 requires_srinfo N/A N/A self N/A N/A N/A  Specifies whether or not this command requires search results
            information.

            If :const:`True` the full path to a search results information file
            is provided by :attr:`SearchCommand.input_header['infoPath']`.

            Default: :const:`False`

             N/A N/A N/A type self _requires_srinfo N/A property N/A _requires_srinfo False run_in_preview N/A N/A self N/A N/A N/A  Tells Splunk whether to run this command when generating results
            for preview rather than final output.

            Default: :const:`True`

             N/A N/A N/A type self _run_in_preview N/A property N/A _run_in_preview True stderr_dest N/A N/A self N/A N/A N/A  Tells Splunk what to do with messages logged to `stderr`.

            Specify one of these string values:

            ================== ========================================================
            Value              Meaning
            ================== ========================================================
            :code:`'log'`      Write messages to the job's search.log file
            :code:`'message'`  Write each line of each message as a search info message
            :code:`'none'`     Discard all messages logged to stderr
            ================== ========================================================

            Default: :code:`'log'`

             N/A N/A N/A type self _stderr_dest N/A property N/A _stderr_dest log supports_multivalues N/A N/A self N/A N/A N/A  Signals that this search command supports multivalues.

            Fixed: :const:`True`

             N/A True N/A property supports_rawargs N/A N/A self N/A N/A N/A  Signals that this search command parses raw arguments.

            Fixed: :const:`True`

             N/A True N/A property required_fields N/A N/A self N/A N/A N/A  Specifies a comma-separated list of required field names.

            This list is computed as the union of the set of fieldnames and
            fieldname-valued options given as argument to this command.

             N/A fieldnames N/A set N/A N/A self command fieldnames N/A N/A name option N/A N/A N/A N/A self command options iteritems N/A N/A N/A isinstance N/A option validator Fieldname N/A N/A value N/A option value N/A N/A value None N/A N/A N/A N/A fieldnames add value N/A text N/A N/A , join fieldnames N/A text N/A property configuration_settings N/A N/A cls N/A N/A N/A  Represents this class as a dictionary of :class:`property`
            instances and :code:`backing_field` names keyed by configuration
            setting name.

            This method is used by the :class:`ConfigurationSettingsType`
            meta-class to construct new :class:`ConfigurationSettings` classes.
            It is also used by instances of this class to retrieve configuration
            setting names and their values. See :meth:`SearchCommand.keys` and
            :meth:`SearchCommand.items`.

             N/A N/A N/A cls _settings None N/A N/A is_property N/A N/A N/A x N/A N/A isinstance x property N/A N/A cls _settings N/A N/A N/A name prop N/A getmembers cls is_property N/A N/A backing_field N/A _ name N/A N/A N/A hasattr cls backing_field N/A N/A backing_field None N/A N/A N/A cls _settings N/A name N/A prop backing_field N/A N/A cls _settings N/A classmethod fix_up N/A N/A cls command_class N/A N/A N/A  Adjusts and checks this class and its search command class.

            Derived classes must override this method. It is used by the
            :decorator:`Configuration` decorator to fix up the
            :class:`SearchCommand` classes it adorns. This method is overridden
            by :class:`GeneratingCommand`, :class:`ReportingCommand`, and
            :class:`StreamingCommand`, the base types for all other search
            commands.

            :param command_class: Command class targeted by this class

             N/A N/A NotImplementedError SearchCommand.fix_up method must be overridden N/A classmethod items N/A N/A self N/A N/A N/A  Represents this instance as an :class:`OrderedDict`.

            This method is used by the SearchCommand.process method to report
            configuration settings to Splunk during the :code:`__GETINFO__`
            phase of a request to process a chunk of search results.

            :return: :class:`OrderedDict` containing setting values keyed by
            name

             N/A N/A OrderedDict N/A N/A k N/A getattr self k N/A k N/A N/A self keys N/A keys N/A N/A self N/A N/A N/A  Gets the names of the settings represented by this instance.

            :return: Sorted list of setting names.

             N/A N/A sorted N/A N/A N/A N/A N/A type self configuration_settings keys N/A N/A _settings None N/A N/A