GET /cryptoSettings/jobs/<job_id>

Use the GET method to retrieve information about a specific job for changing cryptography settings.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/cryptoSettings/jobs/<job_id>

where <job_id> is the job ID that was returned by the PUT /cryptoSettings method.

Query parameters

None

Request body

None

Response codes

Code Description
200 OK. The request completed successfully.
500 Internal server error. For more information, see the error message in the response body.

Response body

Attributes Type Description
response Object Response content
  progress Double Percentage complete of the job. his can be one of the following values.
  • 0. Created
  • 50. In progress.
  • 100. Complete.
  result Array Information about the job results. There is one entry for each managed device on which cryptographic settings are being changed.
    messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always "com.lenovo.lxca.security.base.bundle.tasks.messages."
    messageID String Message ID for the set of job tasks
    messageAttributes String UUID that is associated with the job
    progress Integer Percentage complete of the job. This value can be 0 - 100.
    result String Result of the request. This can be one of the following values.
  • SUCCESS
  • INCOMPLETE
  • REST_CLIENT_FAIL
  • CRYPTO_PUT_FAIL
  • RECONNECT_FAIL
  • RESOLVE_CERT_FAIL
  • VALIDATION_FAIL
  • CRYPTO_MODE_WRONG
  • PROTOCOL_WRONG
  • OTHER_FAIL
    resultShortDescription String Short description of the result
    resultLongDescription String Long description of the result
    status Object Information about the current status of the job
      description Array  
        messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always "com.lenovo.lxca.security.base.bundle.tasks.messages."
        messageDisplay String Translated label that corresponds to the message ID or to the pre-translated backup string if no message ID is specified
        messageID String Message ID for the set of job tasks
        messageTime String Time when this message was generated
      percentage Long Percentage complete of the job
      state   State of the job. his can be one of the following values.
  • Aborted

  • Blocked

  • Cancelled

  • CancelledWithError

  • CancelledWithWarning

  • Cancelling

  • Complete

  • CompleteWithError

  • CompleteWithWarning

  • Expired

  • Initializing

  • Interrupted

  • InterruptedWithError

  • InterruptedWithWarning

  • Investigating

  • Pending

  • Resolved

  • Running

  • RunningWithError

  • RunningWithWarning

  • Skipped

  • Stopped

  • StoppedWithError

  • StoppedWithWarning

  • Unknown

  • Uploading

  • Validating

  • Waiting

      substatus Array Information about each step in the overall task. There is one entry for each step.
        completed Boolean Indicates whether the step completed. This can be one of the following values.
  • true. The step has completed.
  • false. The task has not completed.
        id String Short name of the step
        longDescription String Long message description
        messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always "com.lenovo.lxca.security.base.bundle.tasks.messages."
        messageID String Message ID for the task
        progress String Progress of the task
        shortDescription String Short message description
        started Boolean Indicates if the management step has started. This can be one of the following values.
  • true. The step has started.
  • false. The step has not started.
        status Object  
          percentage Long Percentage complete of the task.
          state String State of the task. The following values can be returned.
  • Aborted

  • Blocked

  • Cancelled

  • CancelledWithError

  • CancelledWithWarning

  • Cancelling

  • Complete

  • CompleteWithError

  • CompleteWithWarning

  • Expired

  • Initializing

  • Interrupted

  • InterruptedWithError

  • InterruptedWithWarning

  • Investigating

  • Pending

  • Resolved

  • Running

  • RunningWithError

  • RunningWithWarning

  • Skipped

  • Stopped

  • StoppedWithError

  • StoppedWithWarning

  • Unknown

  • Uploading

  • Validating

  • Waiting

        userAction String Any user action that is required
    taskid Integer Name of the job
Note: This job ID might not be the same as the job ID that is returned by the PUT /cryptoSettings method.
    taskName String Name of the job
    time_spent Long Duration of the task in milliseconds
    uuid String UUID of the device for which this job is running
  status String Current status of the overall task. This can be one of the following values.
  • CREATED
  • INCOMPLETE
  • DONE
  title String Job title. This is always "Managed System Cryptography Settings."
result String Results of the request . This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
messages Array 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 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

The following examples shows the status of a completed cryptography-settings job.
{
    response: {
        progress: 100
        results: [1]
        0: {
            messageBundle: "com.lenovo.lxca.security.base.bundle.tasks.messages"
            messageID: "1100_LONG"
            messageParameters: "A4AFBBC4770232049A45C6F315D66236"
            progress: 100
            result: "CRYPTO_PUT_FAIL"
            resultShortDescription: "Command failure"
            resultLongDescription: "The command to change the cryptographic settings on 
                                    the device failed: Failed to set cryptographic 
                                    policy."
            status: {
                description: [2]
                0: {
                    messageBundle: "com.lenovo.lxca.security.base.bundle.tasks.messages",
                    messageDisplay: "Starting device cryptographic settings job",
                    messageID: "1001_LONG",
                    messageTime: "2015-08-04T19:17:12Z"
                },
                1: {
                    messageDisplay: "The command to change the cryptographic settings on 
                                     the device failed: Failed to set cryptographic 
                                     policy.",
                    messageTime: "2015-08-04T19:17:22Z"
                },
                percentage: 100,
                state: "Stopped_With_Error",
                substatus: [5]
                0: {
                    completed: true,
                    id: "STARTING",
                    longDescription: "Starting device cryptographic settings job",
                    messageBundle: "com.lenovo.lxca.security.base.bundle.tasks.messages",
                    messageID: "1001_SHORT",
                    progress: 100,
                    shortDescription: "Starting",
                    started: true,
                    status: {
                        percentage: 100,
                        state: "Complete"
                    },
                    userAction: ""
                },
                1: {
                    completed: false,
                    id: "SET_CRYPTO",
                    longDescription: "Configuring cryptographic settings on the device",
                    messageBundle: "com.lenovo.lxca.security.base.bundle.tasks.messages",
                    messageID: "1002_SHORT",
                    progress: 100,
                    shortDescription: "device configuration",
                    started: true,
                    status: {
                        percentage: 100,
                        state: "Stopped_With_Error"
                    },
                    userAction: "Attempt to address any hardware or firmware compatibility 
                                 issues in the device. Then, open the devices 
                                 management web UI, navigate to the Cryptographic settings
                                 tab in the Security section, and manually change the NIST 
                                 SP 800-131A cryptographic mode and SSL/TLS  protocol level
                                 to match the settings in this server. If the failure 
                                 persists, collect service data and report the problem to 
                                 customer support."
                },
                ...
                4: {
                    completed: false,
                    id: "CRYPTO_CHECK",
                    longDescription: "Verifying the cryptographic settings on the device",
                    messageBundle: "com.lenovo.lxca.security.base.bundle.tasks.messages",
                    messageID: "1005_SHORT",
                    progress: 0,
                    shortDescription: "Settings check",
                    started: false,
                    status: {
                        percentage: 0,
                        state: "Stopped_With_Error"
                    },
                    userAction: ""
                }
            }
        status: "DONE",
        title: "Managed System Cryptography Settings",
        }
    }
    result: "success",
    messages: [1]0: {
        explanation: "",
        id: "FQXHMSE0001I",
        recovery: {
            text: "Information only; no action is required.",
            URL: ""
        },
        text: "The request completed successfully."
    }
}