8ae3332165
- moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
148 lines
3.5 KiB
Plaintext
148 lines
3.5 KiB
Plaintext
---
|
|
layout: commands
|
|
page_title: 'Commands: License'
|
|
sidebar_title: license
|
|
description: >
|
|
The license command provides datacenter-level management of the Consul
|
|
Enterprise license.
|
|
---
|
|
|
|
# Consul License
|
|
|
|
Command: `consul license`
|
|
|
|
<EnterpriseAlert />
|
|
|
|
The `license` command provides datacenter-level management of the Consul Enterprise license. This was added in Consul 1.1.0.
|
|
|
|
If ACLs are enabled then a token with operator privileges may be required in
|
|
order to use this command. Requests are forwarded internally to the leader
|
|
if required, so this can be run from any Consul node in a cluster. See the
|
|
[ACL Guide](https://learn.hashicorp.com/consul/security-networking/production-acls) for more information.
|
|
|
|
```text
|
|
Usage: consul license <subcommand> [options] [args]
|
|
|
|
This command has subcommands for managing the Consul Enterprise license
|
|
Here are some simple examples, and more detailed examples are
|
|
available in the subcommands or the documentation.
|
|
|
|
Install a new license from a file:
|
|
|
|
$ consul license put @consul.license
|
|
|
|
Install a new license from stdin:
|
|
|
|
$ consul license put -
|
|
|
|
Install a new license from a string:
|
|
|
|
$ consul license put "<license blob>"
|
|
|
|
Retrieve the current license:
|
|
|
|
$ consul license get
|
|
|
|
Reset the current license:
|
|
|
|
$ consul license reset
|
|
|
|
For more examples, ask for subcommand help or view the documentation.
|
|
|
|
Subcommands:
|
|
get Get the current license
|
|
put Puts a new license in the datacenter
|
|
reset Resets the license in the datacenter
|
|
```
|
|
|
|
## put
|
|
|
|
This command sets the Consul Enterprise license.
|
|
|
|
Usage: `consul license put [options] LICENSE`
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
The output looks like this:
|
|
|
|
```text
|
|
License is valid
|
|
License ID: 2afbf681-0d1a-0649-cb6c-333ec9f0989c
|
|
Customer ID: 0259271d-8ffc-e85e-0830-c0822c1f5f2b
|
|
Expires At: 2019-05-22 03:59:59.999 +0000 UTC
|
|
Datacenter: *
|
|
Package: premium
|
|
Licensed Features:
|
|
Automated Backups
|
|
Automated Upgrades
|
|
Enhanced Read Scalability
|
|
Network Segments
|
|
Redundancy Zone
|
|
Advanced Network Federation
|
|
```
|
|
|
|
## get
|
|
|
|
This command gets the Consul Enterprise license.
|
|
|
|
Usage: `consul license get [options]`
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
The output looks like this:
|
|
|
|
```text
|
|
License is valid
|
|
License ID: 2afbf681-0d1a-0649-cb6c-333ec9f0989c
|
|
Customer ID: 0259271d-8ffc-e85e-0830-c0822c1f5f2b
|
|
Expires At: 2019-05-22 03:59:59.999 +0000 UTC
|
|
Datacenter: *
|
|
Package: premium
|
|
Licensed Features:
|
|
Automated Backups
|
|
Automated Upgrades
|
|
Enhanced Read Scalability
|
|
Network Segments
|
|
Redundancy Zone
|
|
Advanced Network Federation
|
|
```
|
|
|
|
## reset
|
|
|
|
Resets license for the datacenter to the one builtin in Consul binary, if it is still valid.
|
|
If the builtin license is invalid, the current one stays active.
|
|
|
|
Usage: `consul license reset [options]`
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
The output looks like this:
|
|
|
|
```text
|
|
License is valid
|
|
License ID: 2afbf681-0d1a-0649-cb6c-333ec9f0989c
|
|
Customer ID: 0259271d-8ffc-e85e-0830-c0822c1f5f2b
|
|
Expires At: 2019-05-22 03:59:59.999 +0000 UTC
|
|
Datacenter: *
|
|
Package: premium
|
|
Licensed Features:
|
|
Automated Backups
|
|
Automated Upgrades
|
|
Enhanced Read Scalability
|
|
Network Segments
|
|
Redundancy Zone
|
|
Advanced Network Federation
|
|
```
|