/** * RemoteEntities service. * @version 4.4.1 * @class RemoteEntitiesApi */ export class RemoteEntitiesApi { /** * 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 RemoteEntitiesApi. * @alias module:api/RemoteEntitiesApi * @class * @param {module:ApiClient} [apiClient] Optional API client implementation to use, * default to {@link module:ApiClient#instance} if unspecified. */ constructor(apiClient?: any); apiClient: any; /** * Get remote subnet * Information about a subnet from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @param { String } extId Reference to the specified remote subnet. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetRemoteSubnetApiResponse } and HTTP response */ getRemoteSubnetForClusterById(clusterExtId: string, extId: string, ...args: any): Promise; /** * Get a remote VPN connection * Get a VPN connection from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @param { String } extId Reference to the specified remote VPN connection. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RemoteVpnConnectionApiResponse } and HTTP response */ getRemoteVpnConnectionForClusterById(clusterExtId: string, extId: string, ...args: any): Promise; /** * Get a remote VTEP gateway * Get a VTEP gateway from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @param { String } extId Reference to the specified remote VTEP gateway. * @param {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RemoteVtepGatewayApiResponse } and HTTP response */ getRemoteVtepGatewayForClusterById(clusterExtId: string, extId: string, ...args: any): Promise; /** * List remote subnets * Lists subnets from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @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 {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListRemoteSubnetsApiResponse } and HTTP response */ listRemoteSubnetsByClusterId(clusterExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; }, ...args: any): Promise; /** * List remote VPN connections * Lists VPN connections from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @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 {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RemoteVpnConnectionListApiResponse } and HTTP response */ listRemoteVpnConnectionsByClusterId(clusterExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; }, ...args: any): Promise; /** * List remote VTEP gateways * Lists VTEP gateways from the specified Prism Central cluster. * @param { String } clusterExtId Reference to the Prism Central cluster. * @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 {Object} args Additional Arguments * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RemoteVtepGatewayListApiResponse } and HTTP response */ listRemoteVtepGatewaysByClusterId(clusterExtId: string, opts: { $page: number; $limit: number; $filter: string; $orderby: string; }, ...args: any): Promise; #private; } import GetRemoteSubnetApiResponse from "../models/networking/v4/config/GetRemoteSubnetApiResponse"; import RemoteVpnConnectionApiResponse from "../models/networking/v4/config/RemoteVpnConnectionApiResponse"; import RemoteVtepGatewayApiResponse from "../models/networking/v4/config/RemoteVtepGatewayApiResponse"; import ListRemoteSubnetsApiResponse from "../models/networking/v4/config/ListRemoteSubnetsApiResponse"; import RemoteVpnConnectionListApiResponse from "../models/networking/v4/config/RemoteVpnConnectionListApiResponse"; import RemoteVtepGatewayListApiResponse from "../models/networking/v4/config/RemoteVtepGatewayListApiResponse"; import { ApiClient } from "../ApiClient";