Skip to main content

PATCH – Add KMIP servers

Use the PATCH method to update properties in System resource for Redfish service.

Request URL​

PATCH https://<BMC_IPADDR>/redfish/v1/Systems/1/

Request body​

Properties to be updated are shown as bellow, all of these properties can be changed individually.

Field

Type

Description

KeyManagement

Object

Expanded

 KMIPServers

Array

An array of the KMIP servers to which this computer system is subscribed.

Note
When the tier level is lower than 2, this object belong to this property will not be presented.
  KMIPServers[N]

Object

Expanded

   Address

String

The KMIP server address.

   Port

Int

The KMIP server port.

Response​

The response returns same content as GET operation with updated properties

Status code​

HTTP Status CodeError Message ID

200

RebootRequired

403

InsufficientPrivilege

500

InternalError

503

ServiceUnavailable

Example​

The following example is PATCH body.
Note

  • Please remember to get computer system resource before patching the KMIPServers to make sure the response data is as expected.

  • Please do not request with null in this patch case or return 403.

  • The amount of element in the PATCH request needs equal to 4.

{
    "KeyManagement": {
        "KMIPServers": [
            {
                "Address": "10.10.10.10",
                "Port": 5696
            },
            {
                "Address": "",
                "Port": 5696
            },
            {
                "Address": "",
                "Port": 5696
            },
            {
                "Address": "",
                "Port": 5696
            }
        ]
    }
}

After the PATCH operation runs successfully, querying the system resource returns below example JSON response:

{
    "KeyManagement": {
        "KMIPServers": [
            {
                "Address": "10.10.10.10",
                "Port": 5696
            },
            {
                "Address": null,
                "Port": 5696
            },
            {
                "Address": null,
                "Port": 5696
            },
            {
                "Address": null,
                "Port": 5696
            }
        ],
        "KMIPCertificates": {
            "@odata.id": "/redfish/v1/Systems/1/KeyManagement/KMIPCertificates"
        }
    },
    "IndicatorLED": "Off",
    "UUID": "037a178e-7fdd-11ed-8eb7-833f7a16b2d6",
    "PCIeDevices": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_4"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_3"
        }
    ],
    "Manufacturer": "Lenovo",
    "PCIeFunctions": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_4/PCIeFunctions/ob_4.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_1/PCIeFunctions/ob_1.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_3/PCIeFunctions/ob_3.00"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2/PCIeFunctions/ob_2.00"
        }
    ],
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/1"
            }
        ],
        "PoweredBy": [],
        "CooledBy": [
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/1"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/2"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/3"
            }
        ]
    },
    …
}