/mgmt/config/default/FileSystemUsageMonitor PUT

Use the HTTP PUT method with the /mgmt/config/default/FileSystemUsageMonitor/FileSystemUsageMonitor resource to amend file system monitor settings.

Resource URL

https://host:port/mgmt/config/default/FileSystemUsageMonitor/FileSystemUsageMonitor
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

The request is in JSON format. It can contain the following fields, depending on the system setting that you want to update:
mAdminState
String.
The administrative state of the file system monitor settings, can be one of the following values:
  • enabled
  • disabled
PollingInterval
Integer.
The polling interval for all monitored file system in minutes. The minimum value is 15.
AllSystem
String.
Set to "on" or "off". Set to "on" to monitor all system file systems. The default value is "on".
AllSystemWarningThreshold
Integer.
The percentage of file system that is full to trigger a usage warning notification. This is 75 by default.
AllSystemCriticalThreshold
Integer.
The percentage of file system that is full to trigger a usage critical notification. This is 90 by default.
System
To configure individual settings for system file systems, use this parameter with the following sub-parameters in a JSON structure:
Name
String.
Name of the system file system that these settings apply to. Can be one of the following values:
system
System storage (Flash device)
temporary
Temporary storage (temporary:)
mqroot
IBM MQ root
mqbackup
IBM MQ queue manager backups (mqbackup:///QMgrs)
mqdiag
IBM MQ diagnostics (mqdiag:)
mqerr
IBM MQ errors (mqerr:)
mqtrace
IBM MQ trace (mqtrace:)
WarningThreshold
Integer.
The percentage of file system that is full to trigger a usage warning notification. This is 75 by default.
CriticalThreshold
Integer.
The percentage of file system that is full to trigger a usage critical notification. This is 90 by default.
AllQueueManagers
String.
Set to "on" or "off". Set to "on" to monitor all queue manager file systems. The default value is "on".
AllQMWarningThreshold
Integer.
The percentage of queue manager file system that is full to trigger a usage warning notification. This is 75 by default.
AllQMCriticalThreshold
Integer.
The percentage of queue manager file system that is full to trigger a usage critical notification. This is 90 by default.
QueueManager
To configure individual settings for particular queue managers, use this parameter with the following sub-parameters in a JSON structure:
Name
String.
Name of the queue manager that these settings apply to.
WarningThreshold
Integer.
The percentage of queue manager file system that is full to trigger a usage warning notification. This is 75 by default.
CriticalThreshold
Integer.
The percentage of queue manager file system that is full to trigger a usage critical notification. This is 90 by default.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
The system settings were successfully updated.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. Each object contains the following fields:
self
String.
The URL of the PUT request.
doc
String.
Not currently used.
Location
String.
The URL of the object updated.

Examples

The following example specifies that the polling interval for monitoring file system usage is 30 minutes,. It also specifies a warning threshold of 65 and a critical threshold of 80 for the queue manager QM1, and a .a warning threshold of 80 and a critical threshold of 90 for the queue manager plain1.

The following URL is used with the HTTP PUT method:
PUT /mgmt/config/default/FileSystemUsageMonitor/FileSystemUsageMonitor
The following listing shows the request:
{
  "FileSystemUsageMonitor" : {
    "name" : "FileSystemUsageMonitor",
    "PollingInterval" : 30
    "QueueManager" : [{
        "Name" : "QM1", 
        "WarningThreshold" : 65, 
        "CriticalThreshold" : 80}, {
        "Name" : "plain1", 
        "WarningThreshold" : 80, 
        "CriticalThreshold" : 95}]
  }
}
After the PollingInterval field is updated, the following response is returned:
{
        "_links" : {
          "self" : {
             "href" : "/mgmt/config/default/FileSystemUsageMonitor/FileSystemUsageMonitor"
          }, 
             "doc" : {
               "href" : "/mgmt/docs/config/FileSystemUsageMonitor"
          }
        }, 
        "FileSystemUsageMonitor" : "Configuration was updated."
}