/** * HardwareProviders service. * @version 4.3.1 * @class HardwareProvidersApi */ export class HardwareProvidersApi { /** * 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 HardwareProvidersApi. * @alias module:api/HardwareProvidersApi * @class * @param {module:ApiClient} [apiClient] Optional API client implementation to use, * default to {@link module:ApiClient#instance} if unspecified. */ constructor(apiClient?: any); apiClient: any; /** * Create connection * Creates a connection to an endpoint for a specific hardware provider * @param { Required> & Partial } body specification * @param { String } hardwareProviderExtId External ID of the hardware provider * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateConnectionApiResponse } and HTTP response */ createConnectionByHardwareProviderId(hardwareProviderExtId: string, body: Required> & Partial, ...args: any): Promise; /** * Delete connection * Deletes a hardware provider connection identified by its external ID * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } extId External ID of the connection * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteConnectionApiResponse } and HTTP response */ deleteConnectionById(hardwareProviderExtId: string, extId: string, ...args: any): Promise; /** * Get connection details * Returns details of a hardware provider connection identified by its external ID * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } extId External ID of the connection * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetConnectionApiResponse } and HTTP response */ getConnectionById(hardwareProviderExtId: string, extId: string, ...args: any): Promise; /** * Get discovered node details * Returns details of a node discovered through a specific hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @param { String } extId External ID of the discovered node * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetConnectionNodeApiResponse } and HTTP response */ getConnectionNodeById(hardwareProviderExtId: string, connectionExtId: string, extId: string, ...args: any): Promise; /** * Get hardware provider details * Returns details of a hardware provider identified by its external ID * @param { String } extId External ID of the hardware provider * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetHardwareProviderApiResponse } and HTTP response */ getHardwareProviderById(extId: string, ...args: any): Promise; /** * Get IP address pool details * Returns details of an IP address pool from a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @param { String } extId External ID of the IP address pool * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetIpPoolApiResponse } and HTTP response */ getIpPoolById(hardwareProviderExtId: string, connectionExtId: string, extId: string, ...args: any): Promise; /** * Get MAC address pool details * Returns details of a MAC address pool from a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @param { String } extId External ID of the MAC address pool * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetMacPoolApiResponse } and HTTP response */ getMacPoolById(hardwareProviderExtId: string, connectionExtId: string, extId: string, ...args: any): Promise; /** * Get server identity pool details * Returns details of a server identity pool from a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @param { String } extId External ID of the server identity pool * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetServerIdentityPoolApiResponse } and HTTP response */ getServerIdentityPoolById(hardwareProviderExtId: string, connectionExtId: string, extId: string, ...args: any): Promise; /** * List connections * Returns a paginated list of connections for a specific hardware provider * @param { String } hardwareProviderExtId External ID of the hardware provider * @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 ListConnectionsApiResponse } and HTTP response */ listConnectionsByHardwareProviderId(hardwareProviderExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * List hardware providers * Returns a paginated list of all available hardware providers * @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 ListHardwareProvidersApiResponse } and HTTP response */ listHardwareProviders(opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * List IP address pools * Returns a list of IP address pools available in a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @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 ListIpPoolsApiResponse } and HTTP response */ listIpPoolsByConnectionId(hardwareProviderExtId: string, connectionExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * List MAC address pools * Returns a list of MAC address pools available in a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @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 ListMacPoolsApiResponse } and HTTP response */ listMacPoolsByConnectionId(hardwareProviderExtId: string, connectionExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * List discovered nodes * Returns a list of nodes discovered through a specific hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @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 ListConnectionNodesApiResponse } and HTTP response */ listNodesByConnectionId(hardwareProviderExtId: string, connectionExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * List server identity pools * Returns a list of server identity pools available in a hardware provider connection * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } connectionExtId External ID of the connection * @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 ListServerIdentityPoolsApiResponse } and HTTP response */ listServerIdentityPoolsByConnectionId(hardwareProviderExtId: string, connectionExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; $select: string; }, ...args: any): Promise; /** * Refresh connection * Refresh nodes or resources from a hardware provider connection * @param { Required> & Partial } body specification * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } extId External ID of the connection * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RefreshConnectionApiResponse } and HTTP response */ refreshConnection(hardwareProviderExtId: string, extId: string, body: Required> & Partial, ...args: any): Promise; /** * Update connection * Updates the details of a hardware provider connection identified by its external ID * @param { Required> & Partial } body specification * @param { String } hardwareProviderExtId External ID of the hardware provider * @param { String } extId External ID of the connection * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateConnectionApiResponse } and HTTP response */ updateConnectionById(hardwareProviderExtId: string, extId: string, body: Required> & Partial, ...args: any): Promise; #private; } import Connection from "../models/lifecycle/v4/config/Connection"; import CreateConnectionApiResponse from "../models/lifecycle/v4/config/CreateConnectionApiResponse"; import DeleteConnectionApiResponse from "../models/lifecycle/v4/config/DeleteConnectionApiResponse"; import GetConnectionApiResponse from "../models/lifecycle/v4/config/GetConnectionApiResponse"; import GetConnectionNodeApiResponse from "../models/lifecycle/v4/config/GetConnectionNodeApiResponse"; import GetHardwareProviderApiResponse from "../models/lifecycle/v4/config/GetHardwareProviderApiResponse"; import GetIpPoolApiResponse from "../models/lifecycle/v4/config/GetIpPoolApiResponse"; import GetMacPoolApiResponse from "../models/lifecycle/v4/config/GetMacPoolApiResponse"; import GetServerIdentityPoolApiResponse from "../models/lifecycle/v4/config/GetServerIdentityPoolApiResponse"; import ListConnectionsApiResponse from "../models/lifecycle/v4/config/ListConnectionsApiResponse"; import ListHardwareProvidersApiResponse from "../models/lifecycle/v4/config/ListHardwareProvidersApiResponse"; import ListIpPoolsApiResponse from "../models/lifecycle/v4/config/ListIpPoolsApiResponse"; import ListMacPoolsApiResponse from "../models/lifecycle/v4/config/ListMacPoolsApiResponse"; import ListConnectionNodesApiResponse from "../models/lifecycle/v4/config/ListConnectionNodesApiResponse"; import ListServerIdentityPoolsApiResponse from "../models/lifecycle/v4/config/ListServerIdentityPoolsApiResponse"; import RefreshConnectionSpec from "../models/lifecycle/v4/config/RefreshConnectionSpec"; import RefreshConnectionApiResponse from "../models/lifecycle/v4/config/RefreshConnectionApiResponse"; import UpdateConnectionApiResponse from "../models/lifecycle/v4/config/UpdateConnectionApiResponse"; import { ApiClient } from "../ApiClient";