Skip to content

Commit 6fe9395

Browse files
committed
DOC-4038 Add RS CMUI instructions and screenshot for license expiration alert config
1 parent 249c6c2 commit 6fe9395

File tree

2 files changed

+28
-13
lines changed

2 files changed

+28
-13
lines changed

content/operate/rs/clusters/configure/license-keys.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -93,23 +93,38 @@ When the license is expired:
9393

9494
By default, a cluster license alert is scheduled to occur 7 days before the cluster license expiration date.
9595

96-
To change the cluster license alert settings, use an [update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request.
96+
You can adjust the threshold value of the cluster license expiration alert based on how far in advance you want to be notified of the license expiration. The value should be within a reasonable range that allows your organization enough time to take action, such as renewing the license, before it expires.
9797

98-
The following example changes the cluster license alert to occur 30 days before the cluster license expiration date:
98+
To change the cluster license alert settings, use one of the following methods:
9999

100-
```sh
101-
PUT /v1/cluster
102-
{
103-
"alert_settings": {
104-
"cluster_license_about_to_expire": {
105-
"enabled": true,
106-
"threshold": "30"
100+
- Cluster Manager UI:
101+
102+
1. On the **Cluster > Configuration** screen, select the **Alerts Settings** tab.
103+
104+
1. Click **Edit**.
105+
106+
1. In the **Cluster utilization** section, enable the alert setting "License expiry notifications will be sent \<value\> days before the license expires" and enter a new value in the box.
107+
108+
{{<image filename="images/rs/screenshots/cluster/cluster-config-alert-settings-utilization.png" alt="Cluster utilization alert settings." >}}
109+
110+
1. Click **Save**.
111+
112+
113+
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:
114+
115+
The following example changes the cluster license alert to occur 30 days before the cluster license expiration date:
116+
117+
```sh
118+
PUT /v1/cluster
119+
{
120+
"alert_settings": {
121+
"cluster_license_about_to_expire": {
122+
"enabled": true,
123+
"threshold": "30"
124+
}
107125
}
108126
}
109-
}
110-
```
111-
112-
Adjust the `threshold` value of the `cluster_license_about_to_expire` alert based on how far in advance you want to be notified of the license expiration. The value should be within a reasonable range that allows your organization enough time to take action, such as renewing the license, before it expires.
127+
```
113128

114129
## Monitor cluster license
115130

121 KB
Loading

0 commit comments

Comments
 (0)