REST API - precheck

appliance update pending: precheck

Runs update precheck. This operation was added in vSphere API 6.7.

Request:

HTTP request

POST https://{server}/rest/appliance/update/pending/{version}?action=precheck

Path Parameters

Name Type Description
Required
version string Update version.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "estimated_time_to_rollback" : 1,
        "reboot_required" : true,
        "questions" : [
            {
                "allowed_values" : [
                    "string",
                    "string"
                ],
                "regexp" : "string",
                "description" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "data_item" : "obj-103",
                "default_answer" : "string",
                "text" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "type" : "PLAIN_TEXT"
            },
            {
                "allowed_values" : [
                    "string",
                    "string"
                ],
                "regexp" : "string",
                "description" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "data_item" : "obj-103",
                "default_answer" : "string",
                "text" : {
                    "args" : [
                        "string",
                        "string"
                    ],
                    "default_message" : "string",
                    "localized" : "string",
                    "id" : "string",
                    "params" : [
                        {
                            "value" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : [
                                        {
                                            "value" : {
                                                "dt" : "2015-01-01T22:13:05.651Z",
                                                "s" : "string",
                                                "d" : 1.5,
                                                "precision" : 1,
                                                "format" : "SHORT_DATE",
                                                "i" : 1,
                                                "l" : {
                                                    "id" : "string",
                                                    "params" : [
                                                        {
                                                            "key" : "string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key" : "string"
                                        }
                                    ]
                                }
                            },
                            "key" : "string"
                        }
                    ]
                },
                "type" : "PLAIN_TEXT"
            }
        ],
        "issues" : {
            "warnings" : [
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                },
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                }
            ],
            "errors" : [
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                },
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                }
            ],
            "info" : [
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                },
                {
                    "id" : "string",
                    "time" : "2015-01-01T22:13:05.651Z",
                    "message" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "resolution" : {
                        "args" : [
                            "string",
                            "string"
                        ],
                        "default_message" : "string",
                        "localized" : "string",
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "value" : {
                                                    "dt" : "2015-01-01T22:13:05.651Z",
                                                    "s" : "string",
                                                    "d" : 1.5,
                                                    "precision" : 1,
                                                    "format" : "SHORT_DATE",
                                                    "i" : 1,
                                                    "l" : {
                                                        "id" : "string",
                                                        "params" : [
                                                            {
                                                                "key" : "string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                }
            ]
        },
        "check_time" : "2015-01-01T22:13:05.651Z",
        "estimated_time_to_install" : 1
    }
}

Response Type:

Name Type Description
bold = required
value precheck_result PrecheckResult.
value.check_time date_time Time when this precheck was run. This attribute was added in vSphere API 6.7.

value.estimated_time_to_install long Rough estimate of time to install the update (minutes). This attribute was added in vSphere API 6.7.

Optional. estimatedTimeToInstall If unset N/A.

value.estimated_time_to_rollback long Rough estimate of time to rollback the update (minutes). This attribute was added in vSphere API 6.7.

Optional. estimatedTimeToRollback If unset N/A.

value.reboot_required boolean Is reboot required to install the update. This attribute was added in vSphere API 6.7.

value.issues notifications Lists of the issues and warnings. This attribute was added in vSphere API 6.7.

Optional. issues If unset N/A.

value.issues.info notification[] Info notification messages reported. This attribute was added in vSphere API 6.7.

Optional. Only set if an info was reported by the appliance task.

value.issues.info[].id string The notification id. This attribute was added in vSphere API 6.7.

value.issues.info[].time date_time The time the notification was raised/found. This attribute was added in vSphere API 6.7.

Optional. Only if the time information is available.

value.issues.warnings notification[] Warning notification messages reported. This attribute was added in vSphere API 6.7.

Optional. Only set if an warning was reported by the appliance task.

value.issues.errors notification[] Error notification messages reported. This attribute was added in vSphere API 6.7.

Optional. Only set if an error was reported by the appliance task.

value.questions question[] List of questions that must be answered to install the update. This attribute was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation
404 not_found the update is not found
400 already_in_desired_state if this version is already installed
400 not_allowed_in_current_state if another operation is in progress