/** * LcmHistories service. * @version 4.3.1 * @class LcmHistoriesApi */ export class LcmHistoriesApi { /** * 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 LcmHistoriesApi. * @alias module:api/LcmHistoriesApi * @class * @param {module:ApiClient} [apiClient] Optional API client implementation to use, * default to {@link module:ApiClient#instance} if unspecified. */ constructor(apiClient?: any); apiClient: any; /** * Export LCM operation history as a downloadable file. * Export the LCM operation history of connected clusters as a downloadable file. The exported file contains records of past inventory, upgrade, and upload operations including their statuses, timestamps, and component details. The operation is asynchronous and returns a TaskReference. Once the task completes successfully, the URL to download the exported file is available in the completion_details field of the task. Submit an ExportHistorySpec with the desired file format (CSV). Requires the NTNX-Request-Id header (a UUID v4 value) for idempotency. * @param { Required> & Partial } body specification * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ExportHistoriesApiResponse } and HTTP response */ exportHistories(body: Required> & Partial, ...args: any): Promise; /** * Retrieve details of a single LCM operation history entry. * Retrieve the full details of a single LCM operation history entry by its identifier. The response includes the operation type (inventory, upgrade, or upload), start and end timestamps, overall status, user information, LCM framework version, and detailed component-level results. Use this endpoint to inspect the outcome of a specific past operation. * @param { String } extId The external identifier (UUID) of the LCM history entry. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetLcmHistoryByIdApiResponse } and HTTP response */ getLcmHistoryById(extId: string, ...args: any): Promise; /** * List LCM operation history entries. * Retrieve a paginated list of LCM operation history entries across all clusters in a Prism Central environment. Supports standard query parameters for pagination ($page, $limit), filtering ($filter by operation type, status, cluster, time range), sorting ($orderby), and field projection ($select). Each history entry summarizes a past inventory, upgrade, or upload operation. Use POST /lcm-histories/$actions/export to download the full history as a file. * @param {Object} opts Optional parameters defined for the operation * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results. If both $page and $apply query parameters are present, $page will be applied on entities within the groups. * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set. If both $limit and $apply query parameters are present, $limit will be applied on entities within the groups. Default value of limit with $apply will be 5. * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.
* For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'. If both $filter and $apply query parameters are present, $filter will be applied on entities within the groups. * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. If both $orderby and $apply query parameters are present, $orderby will be applied on entities within the groups. * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. If both $select and $apply query parameters are present, $select will be applied on entities within the groups. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListLcmHistoriesApiResponse } and HTTP response */ listLcmHistories(opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; #private; } import ExportHistorySpec from "../models/lifecycle/v4/resources/ExportHistorySpec"; import ExportHistoriesApiResponse from "../models/lifecycle/v4/resources/ExportHistoriesApiResponse"; import GetLcmHistoryByIdApiResponse from "../models/lifecycle/v4/resources/GetLcmHistoryByIdApiResponse"; import ListLcmHistoriesApiResponse from "../models/lifecycle/v4/resources/ListLcmHistoriesApiResponse"; import { ApiClient } from "../ApiClient";