/mgmt/config/default/FileSystemUsageMonitor GET

Use the HTTP GET method with the /mgmt/config/default/FileSystemUsageMonitor resource to request a list of current appliance file system usage monitor settings.

Resource URL

https://host:port/mgmt/config/default/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

None.

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
Information retrieved successfully.
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. The response includes the following fields:
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
If you have configured individual settings for system file systems, this parameter appears and contains the following sub-parameters for each system defined:
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
If you have configured individual settings for particular queue managers, this parameter appears and contains the following sub-parameters for each queue manager:
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.

Examples

The following example requests the file system usage monitor information on the appliance:

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/FileSystemUsageMonitor
The following listing shows the received response:
{
    "_links": {
        "self": {
            "href": "/mgmt/config/default/FileSystemUsageMonitor"
        },
        "doc": {
            "href": "/mgmt/docs/config/FileSystemUsageMonitor"
        }
    },
    "FileSystemUsageMonitor": {
        "name": "FileSystemUsageMonitor",
        "_links": {
            "self": {
                "href": "/mgmt/config/default/FileSystemUsageMonitor/FileSystemUsageMonitor"
            },
            "doc": {
                "href": "/mgmt/docs/config/FileSystemUsageMonitor"
            }
        },
        "mAdminState": "enabled",
        "PollingInterval": 60,
        "AllSystem": "on",
        "AllSystemWarningThreshold": 75,
        "AllSystemCriticalThreshold": 90,
        "AllQueueManagers": "on",
        "AllQMWarningThreshold": 75,
        "AllQMCriticalThreshold": 90,
        "QueueManager" : [
          {
            "Name" : "QM1", 
            "WarningThreshold" : 65, 
            "CriticalThreshold" : 80
          }, 
          {
            "Name" : "plain1", 
            "WarningThreshold" : 80, 
            "CriticalThreshold" : 95
          }
        ]
    }
}