ModifyClusterFullThreshold
Suggest changes
PDFs
You can use the ModifyClusterFullThreshold method to change the level at which the system generates an event when the storage cluster approaches a certain capacity utilization. You can use the threshold setting to indicate the acceptable amount of utilized block storage before the system generates a warning.
For example, if you want to be alerted when the system reaches 3% below the "Error" level block storage utilization, enter a value of "3" for the stage3BlockThresholdPercent parameter. If this level is reached, the system sends an alert to the Event Log in the Cluster Management Console.
Parameters
This method has the following input parameters:
|
You must select at least one parameter. |
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
maxMetadataOverProvisionFactor |
A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. For example, if there was enough metadata space to store 100 TiB of volumes and this number was set to 5, then 500 TiB worth of volumes could be created. |
integer |
5 |
No |
stage2AwareThreshold |
The number of nodes of capacity remaining in the cluster before the system triggers a capacity notification. |
integer |
None |
No |
stage3BlockThresholdPercent |
The percentage of block storage utilization below the "Error" threshold that causes the system to trigger a cluster "Warning" alert. |
integer |
None |
No |
stage3MetadataThresholdPercent |
The percentage of metadata storage utilization below the “Error” threshold that causes the system to trigger a cluster “Warning” alert. |
integer |
None |
No |
Return values
This method has the following return values:
Name |
Description |
Type |
blockFullness |
The current computed level of block fullness of the cluster.
|
string |
fullness |
Reflects the highest level of fullness between "blockFullness" and "metadataFullness". |
string |
maxMetadataOverProvisionFactor |
A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. For example, if there was enough metadata space to store 100 TiB of volumes and this number was set to 5, then 500 TiB worth of volumes could be created. |
integer |
metadataFullness |
The current computed level of metadata fullness of the cluster.
|
string |
sliceReserveUsedThresholdPct |
Error condition. A system alert is triggered if the reserved slice utilization is greater than the sliceReserveUsedThresholdPct value returned. |
integer |
stage2AwareThreshold |
Awareness condition. The value that is set for "Stage 2" cluster threshold level. |
integer |
stage2BlockThresholdBytes |
The number of bytes being used by the cluster at which a stage 2 fullness condition will exist. |
integer |
stage2MetadataThresholdBytes |
The number of metadata bytes being used by the cluster at which a stage 2 fullness condition will exist. |
|
stage3BlockThresholdBytes |
The number of storage bytes being used by the cluster at which a stage 3 fullness condition will exist. |
integer |
stage3BlockThresholdPercent |
The percent value set for stage 3. At this percent full, a warning is posted in the Alerts log. |
integer |
stage3LowThreshold |
Error condition. The threshold at which a system alert is created due to low capacity on a cluster. |
integer |
stage3MetadataThresholdBytes |
The number of metadata bytes used by the cluster at which a stage 3 fullness condition will exist. |
|
stage4BlockThresholdBytes |
The number of storage bytes being used by the cluster at which a stage 4 fullness condition will exist. |
integer |
stage4CriticalThreshold |
Error condition. The threshold at which a system alert is created to warn about critically low capacity on a cluster. |
integer |
stage4MetadataThresholdBytes |
The number of metadata bytes used by the cluster at which a stage 4 fullness condition will exist. |
|
stage5BlockThresholdBytes |
The number of storage bytes used by the cluster at which a stage 5 fullness condition will exist. |
integer |
stage5MetadataThresholdBytes |
The number of metadata bytes used by the cluster at which a stage 5 fullness condition will exist. |
|
sumTotalClusterBytes |
The physical capacity of the cluster, measured in bytes. |
integer |
sumTotalMetadataClusterBytes |
The total amount of space that can be used to store metadata. |
integer |
sumUsedClusterBytes |
The number of storage bytes used on the cluster. |
integer |
sumUsedMetadataClusterBytes |
The amount of space used on volume drives to store metadata. |
integer |
Request example
Requests for this method are similar to the following example:
{
"method" : "ModifyClusterFullThreshold",
"params" : {
"stage3BlockThresholdPercent" : 3
},
"id" : 1
}
Response example
This method returns a response similar to the following example:
{
"id": 1,
"result": {
"blockFullness": "stage1Happy",
"fullness": "stage3Low",
"maxMetadataOverProvisionFactor": 5,
"metadataFullness": "stage3Low",
"sliceReserveUsedThresholdPct": 5,
"stage2AwareThreshold": 3,
"stage2BlockThresholdBytes": 2640607661261,
"stage3BlockThresholdBytes": 8281905846682,
"stage3BlockThresholdPercent": 3,
"stage3LowThreshold": 2,
"stage4BlockThresholdBytes": 8641988709581,
"stage4CriticalThreshold": 1,
"stage5BlockThresholdBytes": 12002762096640,
"sumTotalClusterBytes": 12002762096640,
"sumTotalMetadataClusterBytes": 404849531289,
"sumUsedClusterBytes": 45553617581,
"sumUsedMetadataClusterBytes": 31703113728
}
}
New since version
9.6