/** * Prechecks service. * @version 4.3.1 * @class PrechecksApi */ export class PrechecksApi { /** * Make the default {@link ApiClient} class available for developers to be able to extend it and bring * their own fetch methods into the SDK */ static get ApiClient(): typeof ApiClient; /** * Constructs a new PrechecksApi. * @alias module:api/PrechecksApi * @class * @param {module:ApiClient} [apiClient] Optional API client implementation to use, * default to {@link module:ApiClient#instance} if unspecified. */ constructor(apiClient?: any); apiClient: any; /** * Run pre-upgrade validation checks for a planned upgrade. * Run pre-upgrade validation checks to verify that the cluster and its entities are ready for an upgrade. Prechecks detect conditions that would cause an upgrade to fail, such as insufficient disk space, cluster health issues, incompatible configurations, or pinned VMs that cannot be migrated during host maintenance mode. Submit a PrechecksSpec containing the entityUpdateSpecs (entity UUID and target version pairs) that you intend to use for the upgrade. The entityUpdateSpecs should match the output from POST /$actions/compute-recommendations or be manually constructed from GET /entities data. When operating from Prism Central, supply the X-Cluster-Id header to target a specific Prism Element cluster; if omitted, the operation targets the Prism Central cluster itself. The operation is asynchronous and returns a TaskReference; inspect the task result to determine whether all prechecks passed. If prechecks fail, address the reported issues before proceeding to POST /$actions/upgrade. Use the skippedPrecheckFlags field to bypass specific prechecks (e.g. the pinned-VM check). Requires the NTNX-Request-Id header (a UUID v4 value) for idempotency. * @param { Required> & Partial } body specification * @param {Object} opts Optional parameters defined for the operation * @param { String } opts.xClusterId The cluster UUID on which the resource is present or the operation is being performed. * @param { Boolean } opts.$dryrun A URL query parameter that allows long running operations to execute in a dry-run mode providing ability to identify trouble spots and system failures without performing the actual operation. Additionally this mode also offers a summary snapshot of the resultant system in order to better understand how things fit together. The operation runs in dry-run mode only if the provided value is true. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link PrechecksApiResponse } and HTTP response */ performPrechecks(body: Required> & Partial, opts: { xClusterId: string; $dryrun: boolean; }, ...args: any): Promise; #private; } import PrechecksSpec from "../models/lifecycle/v4/common/PrechecksSpec"; import PrechecksApiResponse from "../models/lifecycle/v4/operations/PrechecksApiResponse"; import { ApiClient } from "../ApiClient";