/mgmt/config/default/SystemSettings GET

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

Resource URL

https://host:port/mgmt/config/default/SystemSettings
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 system settings, can be one of the following values:
  • enabled
  • disabled
ProductOID
String.
Identifies the software installed on the appliance. A read-only value.
Description
String.
Identifies the appliance as an IBM MQ Appliance. A read-only value.
SerialNumber
String.
The serial number of the appliance. A read-only value.
EntitlementNumber
String
After an appliance replacement, the serial number of the original appliance should be specified here. Otherwise, is set to the current serial number. (Without the original serial number, IBM cannot entitle the replacement appliance for maintenance or warranty services.)
ProductID
String
Identifies the model number of the appliance. A read-only value.
CapacityMode
String
Indicates whether you have an A license or a B license, which specifies the appliance capacity. A read-only value.
Contact
String
Contact details for the person or organization responsible maintenance and management of the appliance.
SystemName
String
The name of the appliance. The name must be a 7-bit US-ASCII string of 127 characters or less consisting of letters, numbers, underscore, or embedded dashes, dots, or spaces. A unique name with a length of 64 characters or less is recommended.
Location
String
A description of the physical location of the appliance.
Services
Integer
A read-only hexadecimal value that indicates the appliance support for application, presentation, session, and data-link layer services. A read-only value.
BackupMode
String
Indicates whether a secure back up is allowed. A read-only value.
ProductMode
String
Indicates the operational mode of the appliance. A read-only value.
AuditReserve
Integer
Specifies the amount of disk space to reserve for audit records. Enter a value in the range 0 - 10000. The default value is 40.
DetectIntrusion
String
Specify whether the intrusion detection feature is enabled. Set to Enable or Disable.
Locale
String
Specify the locale for the appliance.
SystemLogFixedFormat
String
Specifies whether to enable fixed format in system logs. Set to On or Off.

Examples

The following example requests the system settings on the appliance:

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/SystemSettings
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/config/default/SystemSettings"
    },
    "doc": {
      "href": "/mgmt/docs/config/SystemSettings",   
         "_links" : {
           "self" : {
            "href" : "/mgmt/config/default/SystemSettings/System-Settings"
           }, 
           "doc" : {
             "href" : "/mgmt/docs/config/SystemSettings"
           }
         },
        "mAdminState" : "enabled", 
        "ProductOID" : "1.3.6.1.4.1.180858.1.9", 
        "Description" : "IBM MQ Appliance", 
        "SerialNumber" : "7800666", 
        "EntitlementNumber" : "7800666", 
        "ProductID" : "844154X [Rev A1 02-1]", 
        "CapacityMode" : "A", 
        "Contact" : "Bill Gamsworth", 
        "SystemName" : "JACKDAWS_ASH", 
        "Location" : "HCDC Rack CB6", 
        "Services" : 72, 
        "BackupMode" : "normal", 
        "ProductMode" : "normal", 
        "AuditReserve" : 40, 
        "DetectIntrusion" : "enable", 
        "Locale" : "en", 
        "SystemLogFixedFormat" : "off"
   }
}