open-consul/website/content/commands/license.mdx

148 lines
3.5 KiB
Plaintext
Raw Normal View History

2018-05-22 16:07:13 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: License'
sidebar_title: license
2018-05-22 16:07:13 +00:00
description: >
2020-04-07 18:55:19 +00:00
The license command provides datacenter-level management of the Consul
Enterprise license.
2018-05-22 16:07:13 +00:00
---
# Consul License
Command: `consul license`
<EnterpriseAlert />
2018-05-22 16:07:13 +00:00
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.
2018-05-22 16:07:13 +00:00
```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
2020-07-08 23:09:00 +00:00
Reset the current license:
$ consul license reset
2018-05-22 16:07:13 +00:00
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
2018-05-22 16:07:13 +00:00
```
## put
This command sets the Consul Enterprise license.
Usage: `consul license put [options] LICENSE`
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
2020-04-07 23:56:08 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
2018-05-22 16:07:13 +00:00
The output looks like this:
2020-04-07 23:56:08 +00:00
```text
2018-05-22 16:07:13 +00:00
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
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
2020-04-07 23:56:08 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
2018-05-22 16:07:13 +00:00
The output looks like this:
2020-04-07 23:56:08 +00:00
```text
2018-05-22 16:07:13 +00:00
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
2020-04-07 18:55:19 +00:00
```
## reset
2020-07-08 23:09:00 +00:00
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
```