/mgmt/config/default/SystemSettings PUT

Use the HTTP PUT method with the /mgmt/config/default/SystemSettings/System-Settings resource to amend system settings.

Resource URL

https://host:port/mgmt/config/default/SystemSettings/System-Settings
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 system settings, can be one of the following values:
  • enabled
  • disabled
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.)
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.
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. Can be one of the following values:
  • de
  • en
  • es
  • fr
  • it
  • ja
  • ko
  • pt_BR
  • zh_CN
  • zh_TW
  • ru
The language must be enabled before you can select it as a locale.
SystemLogFixedFormat
String
Specifies whether to enable fixed format in system logs. Set to On or Off.

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 sets the location of the appliance to be "basement west rack 10".

The following URL is used with the HTTP PUT method:
PUT /mgmt/config/default/SystemSettings/System-Settings
The following listing shows the request:
{
  "SystemSettings" : {
    "name" : "System-Settings",
    "Location" : "basement west rack 10"
  }
}
After the Location field is updated, the following response is returned:
{
   "_links" : {
     "self" : {
        "href" : "/mgmt/config/default/SystemSettings/System-Settings"
     }, 
        "doc" : {
          "href" : "/mgmt/docs/config/SystemSettings"
     }
   }, 
   "System-Settings" : "Configuration was updated."
}