Manage licenses from the CLI
This topic describes using the Splunk CLI to monitor and manage your Splunk licenses. Before you continue, review these topics:
- Read "How Splunk licensing works" in this manual for an introduction to Splunk licensing.
- Read "Groups, stacks, pools, and other terminology" in this manual for more information about Splunk license terms.
This topic only covers what CLI commands you can use to interact with Splunk's licenser-related objects. Some of these commands also have required and optional arguments that you can specify for each object. For the complete syntax and usage examples, refer to Splunk's CLI help.
- Read "About the CLI" in this manual for an introduction to using the Splunk command line interface.
For information on managing licenses through Splunk's REST API, refer to "Licenses" in the REST API Reference Manual.
CLI licenser commands and objects
Using the Splunk CLI, you can add, edit, list, and remove licenses and licenser-related objects. The available commands are:
|add||licenses, licenser-pools||Add a license or a pool of licenses to a license stack. This command is only available if you have an Enterprise license.|
|edit||licenser-localslave, licenser-pools||Edit the attributes of a local licenser-slave node or a pool of licenses within a license stack. This command is only available if you have an Enterprise license.|
|list||licenser-groups, licenser-localslave, licenser-messages, licenser-pools, licenser-slaves, licenser-stacks, licenses||Depending on the licenser-related object specified, lists either the attributes of that object or members of that object.|
|remove||licenser-pools, licenses||Remove licenses or license pools from a license stack.|
License-related objects are:
|licenser-groups||the different license groups you can switch to.|
|licenser-localslave||a local indexer's configuration.|
|licenser-messages||the alerts or warnings about the state of your licenses.|
|licenser-pools||a pool, or virtual license. A stack can be divided into various pools, with multiple slaves sharing the quota of each pool.|
|licenser-slaves||all the slaves that have contacted the master.|
|licenser-stacks||this object represents a stack of licenses. A stack contains licenses of the same type and are cumulative.|
|licenses||all licenses for this Splunk instance.|
The following are examples of common licenser-related tasks.
To add a new license to the license stack, specify the path to the license file:
./splunk add licenses /opt/splunk/etc/licenses/enterprise/enterprise.lic
To list all the licenses in a license stack:
./splunk list licenses
List also displays the properties of each license, including the features it enables (features), the license group and stack it belongs to (group_id, stack_id), the indexing quote it allows (quota), and the license key that is unique for each license (license_hash).
If a license expires, you can remove it from the license stack. To remove a license from the license stack, specify the license's hash:
./splunk remove licenses BM+S8VetLnQEb1F+5Gwx9rR4M4Y91AkIE=781882C56833F36D
Managing license pools
You can create a license pool from one or more licenses in a license stack (if you have an Enterprise license). Basically, a license stack can be carved up into multiple licenser pools. Each pool can have more than one license slave sharing the quota of the pool.
To see all the license pools in all the license stacks:
./splunk list licenser-pools
To add a license pool to the stack, you need to: name the pool, specify the stack that you want to add it to, and specify the indexing volume allocated to that pool:
./splunk add licenser-pools pool01 -quota 10mb -slaves guid1,guid2 -stack_id enterprise
You can also specify a description for the pool and the slaves that are members of the pool (these are optional).
You can edit the license pool's description, indexing quota, and slaves:
./splunk edit licenser-pools pool01 -description "Test" -quota 15mb -slaves guid3,guid4 -append_slaves true
This basically adds a description for the pool, "Test", changes the quota from 10mb to 15mb, adds slaves guid3 and guid4 to the pool (instead of overwriting or replace guid1 and guid2).
To remove a license pool from a stack, specify the name:
./splunk remove pool01
Managing license slaves
A license slave is a member of one or more license pools. The license slaves access to license volume is controlled by its license master.
To list all the license slaves that have contacted the license master:
./splunk list licenser-slaves
To list all the properties of the local license slave:
./splunk list licenser-localslave
To add a license slave, edit the attributes of that local license slave node (specify the uri of the splunkd license master instance or 'self'):
./splunk edit licenser-localslave -master_uri 'https://master:port'
Monitoring license status
You can use the list command to view messages (alerts or warnings) about the state of your licenses.
./splunk list licenser-messages
More about Splunk Free
What are apps and add-ons?
This documentation applies to the following versions of Splunk® Enterprise: 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7, 5.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.0.10, 5.0.11, 5.0.12, 5.0.13, 5.0.14, 5.0.15, 5.0.16, 5.0.17, 5.0.18, 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.0.11, 6.0.12, 6.0.13, 6.0.14, 6.0.15, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 6.1.12, 6.1.13, 6.1.14