

By default if you specify -app and/or -user btool will return results from the replicated knowledge bundle (e.g. This argument/flag is unique to the SPL command and is used in conjunction with the -app and/or -user arguments. Without this argument btool will return values from a particular app (if the -app argument is provided), or from all apps following global context resolution order. user) at which point the user context is set as the same user who is executing the search. Unlike the command like version of btool, this argument can be used as a bare argument (i.e. If you specify this argument, you must also specify the -app argument. userĭescription: This argument is used to specify a user context (by username) that btool should examine, and btool will return values from anywhere following app/user context resolution order. Without this argument, btool returns values from all apps following global context resolution order. app) at which point the app context is set as the same app context in which the search is executing. By itself it will return values that are set only within a particular app context, but also see the -user and -local arguments that can be used in conjunction with this argument. appĭescription: This argument is used to specify an app context (by url/disk path) that btool should examine. Specifying or omitting it with this SPL command does nothing. The btool command here always invokes the CLI with the -debug option (to make source information available). Without this positional argument, btool will return all available stanzas for the specified conf file -debugĪgain a syntatic holdover from the CLI. For example, if you only want the file monitor stanzas, you can use | btool inputs list monitor: The third positional argument is optionally a prefix of what stanzas to return from the btool command. On the command line, btool supports a number of other functions and this word is likewise required to make copy and paste from SPL to CLI easier, but this search command only supports the list operation. The second positional argument must be the literal word list. For example if looking for settings in nf files this would be indexes list The first positional argument is short name of the configuration file that you want to get data about without the. | btool list ] ] Required Arguments conf-file-spec or is splunk_server the extracted key will be extracted as VALUE_(originalname) instead) Syntax if a key does happen to start with an underscore (and thus be hidden from field lists in splunk), btool. conf files whereas btool.* and splunk_server are not. As a result most of the syntax of this command mirrors that of the CLI command.Įvery event will be a separate merged stanza (or a separate key value pair using -kvpairs) with set attributes extracted as independent fields, and metadata available as btool.* fields and the source splunk_server available as the splunk_server field (This was a deliberate design decision since host is likely to be set in certain. The btool command is a distributed event-generating command that operates like running btool list -debug on the current search head and/or any subset of search peers.Ī design goal of this search command is to be as close as possible to running btool on the command line of all your splunk hosts, with all the field enrichment to make searching and analysis easy. This app provides btool and bundlefiles search commands, access to which are controlled by custom capabilities named in parentheses in the headers of the below sections. Feedback is always welcome and appreciated! Learn more about splunk-usergroups slack here: Help Note: While this app is not formally supported, the developer can be reached at OR in splunk-usergroups slack, Responses are made on a best effort basis. These commands are marked as risky out of the box because they are python and can expose system information. No communication will go beyond the boundary of deployed Splunk environment. Privacy Note: These search commands make it easier to pull data about the local and remote search peers, and if deployed on a Search Head Cluster, can communicate across the search heads in the same cluster.

On the new Splunkbase website, see the Installation tab for dependencies and setup instructions, the Details tab for usage information, and the Troubleshooting tab for common issues. Admin's Little Helper for Splunk is a collection of utilities to help make Splunk Cloud and Splunk Enterprise Admin's lives easier.
