Manually assign searches to workload pools

While using workload rules to assign searches to workload pools automatically provides the most efficient method for allocating resources, you can also assign searches to workload pools manually.

This page shows you how to assign searches to workload pools manually. For detailed instructions on how to assign searches to workload pools automatically using workload rules, see Create workload rules.

To assign a search to a workload pool manually, a role must have list_workload_pools and select_workload_pools capabilities

How to assign a search to a workload pool manually depends on the type of search.

Assign a scheduled search to a workload pool

You can assign a scheduled search to a workload pool using Splunk Web, CLI, or REST.

When you assign a scheduled search to a workload pool, the pool information is written to savedsearches.conf. For more information, see savedsearches.conf.spec.

Assign a scheduled search using Splunk Web

To assign a scheduled search to a workload pool using Splunk Web, follow these steps:

1. Click on Settings > Searches, Reports, and Alerts.
2. Find the specific saved search, and click Edit > Advanced Edit.
3. In the Workload Pool field, enter the name of the pool.
4. Click Save.
   The workload pool information is written to local/savedsearches.conf and the scheduled search runs in the specified pool.

Assign a scheduled search using the CLI

To assign a scheduled search to a workload pool, run the following CLI command:

./splunk add saved-search -name <search_name> -workload_pool <pool_name>

Assign a scheduled search using REST

Send a POST request to the saved/searches/{name} endpoint. For example:

curl -k -u admin:pass https://localhost:8089/services/searches/<search_name> -d workload_pool=<pool_name>

Assign an ad hoc search to a workload pool

You can assign an ad hoc search to a workload pool using Splunk Web, CLI, or REST.

Assign an ad hoc search using Splunk Web

1. In the Search bar, enter your ad hoc search string.
2. Select a workload pool from the menu.
3. Run the search.
   The ad hoc search job runs in the specified workload pool.
   
   

   If you select Policy-Based Pool, workload management automatically assigns the search to a pool based on any defined workload rules. If an explicit match for the search is not found, workload management assigns the search to the default pool.

   The workload pool menu is only visible to roles that have list_workload_pools and select_workload_pools capabilities.

4. Click Job > Inspect Job > Search job properties.
5. Confirm that the ad hoc search ran in the specified pool. For example:
   

Assign an ad hoc search using CLI

To assign an ad hoc search, run the following CLI command:

./splunk search "index=_internal" -workload_pool=<pool_name>

Assign an ad hoc search using REST

Send a POST request to the search/jobs endpoint. For example:

curl -k -u admin:pass https://localhost:8089/services/search/jobs -d search="search index=_internal" -d workload_pool=pool_1

Change the workload pool for a running search

You can re-assign an actively running search to a different workload pool using Splunk Web or REST. This applies to both scheduled searches and ad hoc searches.

To change the workload pool for a running search, a role must have the list_workload_pools and select_workload_pools capabilities. See Set access controls for workload management.

Change workload pool using Splunk Web

1. Click Activity > Jobs.
2. For the specific running search, click Job > Edit Job Settings.
3. Select a new pool from the Workload Pool menu.
   

Re-assigning an ad hoc search on the Search bar triggers a new search process in the new pool. To continue running the same search process in a new pool, re-assign the search via the Job Activity page or REST endpoint.

Change workload pool using REST

Send a POST request to the search/jobs/{search_id}/control endpoint. For example:

curl -k -u admin:pass https://localhost:8089/services/search/jobs/{search_id}/control -d action=setworkloadpool -d workload_pool=<pool_name>

Assign accelerated reports to workload pools

You can assign any report that qualifies for acceleration to a workload pool.

Assigning an accelerated report to a workload pool with ample cpu and memory resources can help you minimize performance issues that can occur during report acceleration, which can be resource intensive.

You can assign an accelerated report to a workload pool using Splunk Web.

1. Click Settings > Searches, Reports, and Alerts.
2. Find the report you want to accelerate and click Edit > Edit Acceleration.
3. Select the Accelerate Report checkbox.
4. Select the Summary Range for the report acceleration.
5. Select a workload pool from the menu.
6. Click Save.

The workload pool that you specify in the Edit Acceleration modal is written to the auto_summarize.workload_pool setting in savedsearches.conf

For more information on report acceleration, see Accelerate reports in the Reporting Manual.

Assign accelerated data models to workload pools

You can assign an accelerated data model to a workload pool using Splunk Web:

1. Click Settings > Data models.
2. Find the data model you want to accelerate and click Edit > Edit Acceleration.
3. Select the Accelerate checkbox.
4. Select the Summary Range for the data model acceleration.
5. Select a workload pool from the menu.
6. Click Save.

For more information on accelerated data models, see Accelerate data models in the Knowledge Manager Manual.