Skip to content

splunk get-index-volume

Get information about the volume (logical drives) in use by the Splunk deployment.

Description

Access logical drive information

Synopsis

splunk get-index-volume
    --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-index-volume
Output: 
UPDATED                     AUTHOR  NAME              
1970-01-01T05:30:00+05:30   system  _splunk_summaries
Input: 
x= !splunk get-index-volume
Output: 
{
   "links": {},
   "origin": "https://localhost:8089/servicesNS/admin/-/data/index-volumes",
   "updated": "2023-02-07T15:18:34+05:30",
   "generator": {
     "build": "dd0128b1f8cd",
     "version": "9.0.3"
   },
   "entry": [
     {
       "name": "_splunk_summaries",
       "id": "https://localhost:8089/servicesNS/admin/-/data/index-volumes/_splunk_summaries",
       "updated": "1970-01-01T05:30:00+05:30",
       "links": {
         "alternate": "/servicesNS/admin/-/data/index-volumes/_splunk_summaries",
         "list": "/servicesNS/admin/-/data/index-volumes/_splunk_summaries"
       },
       "author": "system",
       "acl": {
         "app": "",
         "can_list": true,
         "can_write": true,
         "modifiable": false,
         "owner": "system",
         "perms": {
           "read": [
             "*"
           ],
           "write": []
         },
         "removable": false,
         "sharing": "system"
       },
       "content": {
         "eai:acl": null,
         "max_size": "infinite",
         "name": "_splunk_summaries",
         "volume_path": "/opt/splunk/var/lib/splunk"
       }
     }
   ],
   "paging": {
     "total": 1,
     "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 "index-volume"
Object ID

Please see Access Control for details.