PUT /serverCertificate

Use the PUT method to generate a self-signed server certificate.

Important: You are disconnected from XClarity Administrator for a short period of time during this request.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/serverCertificate

Query parameters

None

Request body

Attributes Required / Optional Type Description
CommonName Required String The name of the certificate owner. Typically, this is the fully-qualified domain name (FQDN) or IP address of the server that is using the certificate (for example, www.domainname.com or 10.15.23.99).

The length of this value cannot exceed 63 characters.

The default is xHMC.

Country Required String The two-letter ISO 3166 code for the country or region of origin associated with the certificate organization (for example, US for the United States).

The default is US.

Organization Required String The organization (company) that will own the certificate. Typically, this is the legal incorporate name of a company. It should include any suffixes, such as Ltd., Inc., or Corp (for example, ACME International Ltd.).

The length of this value cannot exceed 60 characters.

The default is generated by the server firmware.

OrganizationUnit Required String The organizational unit that will own the certificate (for example, ABC Division).

The length of this value cannot exceed 60 characters.

The default is None.

StateLocality Required String Full name of the locality (city) to be associated with the certificate (for example, San Jose).

The length of the value cannot exceed 50 characters.

The default is Raleigh.

StateProvince Required String Full name of the state or province to be associated with the certificate (for example, California or New Brunswick).

The length of this value cannot exceed 60 characters.

The default is North Carolina.

notBefore Optional String The UTC date and time before which the created certificate is not valid.

Specify the date and time in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ (for example, 2017-01-25T18:00:00Z or 2017-01-25T12:00:00-0600).

If not specified, the value that is used for the certificate generation is the most recently specified notBefore date. If the date has never been specified, the default is 1970-01-01T00:00:00Z.

notAfter Optional String The UTC date and time after which the created certificate is not valid.

Specify the date and time in ISO 8601 formatYYYY-MM-DDTHH:MM:SSZ (for example, 2017-01-25T18:00:00Z or 2017-01-25T12:00:00-0600).

If not specified, the value that is used for the certificate generation is the most recently specified notAfter date. If the date has never been specified, the default 2069-12-31T23:59:59Z.

Request example

{
   "CommonName": "LXCA",
   "Country": "US",
   "Organization": "Generated by Server Firmware",
   "OrganizationUnit": "Organization unit",
   "StateLocality": "Raleigh",
   "StateProvince": "North Carolina",
   "notBefore": "2017-06-01T12:30:00Z",
   "notAfter": "2018-06-01T12:30:00Z"
}

Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. A descriptive error message will be returned in the body.
404 Not found. The specified URI is not valid. A descriptive error message will be returned in the body.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}