Skip to content

splunk get-workloads-status

Get information on the current status of workload management.

Description

Get information on the current status of workload management.

Synopsis

splunk get-workloads-status
    --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-workloads-status
Output: 
UPDATED                     AUTHOR  NAME                       
1970-01-01T05:30:00+05:30   system  admission-control-status    
1970-01-01T05:30:00+05:30   system  workload-management-status
Input: 
x= !splunk get-workloads-status
Output: 
{
   "links": {},
   "origin": "https://localhost:8089/servicesNS/admin/-/workloads/status",
   "updated": "2023-02-07T15:45:21+05:30",
   "generator": {
     "build": "dd0128b1f8cd",
     "version": "9.0.3"
   },
   "entry": [
     {
       "name": "admission-control-status",
       "id": "https://localhost:8089/servicesNS/admin/-/workloads/status/admission-control-status",
       "updated": "1970-01-01T05:30:00+05:30",
       "links": {
         "alternate": "/servicesNS/admin/-/workloads/status/admission-control-status",
         "list": "/servicesNS/admin/-/workloads/status/admission-control-status"
       },
       "author": "system",
       "acl": {
         "app": "",
         "can_list": true,
         "can_write": true,
         "modifiable": false,
         "owner": "system",
         "perms": {
           "read": [
             "admin",
             "splunk-system-role"
           ],
           "write": []
         },
         "removable": false,
         "sharing": "system"
       },
       "content": {
         "eai:acl": null,
         "enabled": "0",
         "search-filter-rules": null
       }
     },
     {
       "name": "workload-management-status",
       "id": "https://localhost:8089/servicesNS/admin/-/workloads/status/workload-management-status",
       "updated": "1970-01-01T05:30:00+05:30",
       "links": {
         "alternate": "/servicesNS/admin/-/workloads/status/workload-management-status",
         "list": "/servicesNS/admin/-/workloads/status/workload-management-status"
       },
       "author": "system",
       "acl": {
         "app": "",
         "can_list": true,
         "can_write": true,
         "modifiable": false,
         "owner": "system",
         "perms": {
           "read": [
             "admin",
             "splunk-system-role"
           ],
           "write": []
         },
         "removable": false,
         "sharing": "system"
       },
       "content": {
         "eai:acl": null,
         "general": {
           "enabled": "0",
           "error_message": "Workload management cannot be enabled on this system because the feature is not supported. Check the status of workload management preflight checks for additional information.",
           "isSupported": "0",
           "os_build": "#64-Ubuntu SMP Thu Jan 5 11:43:13 UTC 2023",
           "os_extended_name": "Linux",
           "os_name": "Linux",
           "os_version": "5.15.0-58-generic"
         },
         "workload-rules": null
       }
     }
   ],
   "paging": {
     "total": 2,
     "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 "workload"
Object ID

Please see Access Control for details.