splunk get-catalog-metrics

List all the metrics available for catalog.

Description

List catalog names.

Synopsis

splunk get-catalog-metrics
    --site <site>
    [--count <count>]
    [--sort_key <sort_key>]
    [--sort_dir <sort_dir>]

Arguments

`site` - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: required

`count` - (int)

     Limit the number of results returned. Set 0 to return all results.
     Example: --count 0
     Default: 0      Attributes: optional

`sort_key` - (string)

     Field name to use for sorting.
     Example: --sort_key "updated"
     Default: updated      Attributes: optional

`sort_dir` - (string)

     Response sort order.
     Example: --sort_dir "sort_dir-1"
     Default: _None_      Attributes: optional

Validation:
allowed values: asc, desc

Examples

Input:

!splunk get-catalog-metrics

Output:

ENTRY                                 
   -

Input:

x= !splunk get-catalog-metrics

Output:

{
   "links": {},
   "origin": "https://localhost:8089/servicesNS/admin/-/catalog/metricstore/metrics",
   "updated": "2023-02-07T14:59:02+05:30",
   "generator": {
     "build": "dd0128b1f8cd",
     "version": "9.0.3"
   },
   "entry": [],
   "paging": {
     "total": 0,
     "perPage": 30,
     "offset": 0
   },
   "messages": []
 }

Access Control

To use this command, you need access to the following:

Field	Value
Action	"read"
Service Type	"splunk"
Service Instance
Namespace
Object Type	"metric"
Object ID

Please see Access Control for details.