sc(1) - f38

1SC(1)                 User Contributed Perl Documentation                SC(1)
2
3
4

NAME

6       sc - Splunk Client
7

SYNOPSIS

9       sc [--host <host>] [--port <port>] [--login <login>] [--password
10       <password>] [--insecure] <subcommand> [<arguments>,...]
11

DESCRIPTION

13       This is remote client for Splunk log search engine based upon
14       WWW::Splunk.  It is currently quite limited in capabilities, but
15       intended and designed to be extended in future.
16

OPTIONS

18       --host <host>
19           Sets remote server to connect to. Defaults to localhost.
20
21       --port <port>
22           Sets port of remote server to connect to. Defaults to 8089.  Please
23           note that this is the management port, not the WWW interface port.
24
25       --login <login>
26           User name of the user to connect to Splunk as. Defaults to admin.
27           The defaults for username and password will probably (hopefully?)
28           not suit your configuration.
29
30       --password <password>
31           Password of the user to connect to Splunk as. Defaults to changeme.
32
33       --insecure
34           Tolerate SSL errors.
35
36       <subcommand> [<arguments>]
37           Subcommand to run. Currently defined is just search.
38

COMMANDS

40   search [-t|--since <time>] [-T|--until <time>] [-f|--format
41       compact|long|raw] <search string>
42       Conduct a search, output the raw log data as they are looked up.
43       Terminate when the search is finished.
44
45       -t, --since <time>
46           Cut off at given time. The time specification is any string
47           understood by Date::Manip. Most common formats apply as well as
48           human-readable relative time specifications (see EXAMPLES).
49
50           Use "rt" for real time search, optionally with specifcation of the
51           search window, such as "rt-10" for 10-second window, or "rt-1m" for
52           one minute.
53
54           Defaults to unlimited.
55
56       -T, --until <time>
57           Do not look for entries newer than given time. The format of the
58           time specification is the same as for --since option.
59
60           If this or --since is "rt" a real-time search is conducted.
61
62       -f, --format compact|long|raw
63           Switch output format style.
64

EXAMPLES

66       sc --host splunk.example.net --login user --password s1kr3t2 search
67       --since '2 days ago' --until yesterday 'network AND error | head 10'
68           Perform a simple search query limited by given time frame.
69
70       sc search --since 'rt-30' 'source=/var/log/httpd/access_log |stats
71       count by http_status_code'
72           Perform a simple real-time search.
73

AUTHORS

78       Lubomir Rintel, <lkundrak@v3.sk>, Michal Josef Špaček <skim@cpan.org>
79
80       The code is hosted on GitHub
81       <http://github.com/tupinek/perl-WWW-Splunk>.  Bug fixes and feature
82       enhancements are always welcome.
83
84
85
86perl v5.36.0                      2023-01-20                             SC(1)