@pulumi/vsphere
Version:
A Pulumi package for creating vsphere resources
123 lines (122 loc) • 4.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `vsphere.getVmfsDisks` data source can be used to discover the storage
* devices available on an ESXi host. This data source can be combined with the
* `vsphere.VmfsDatastore` resource to create VMFS
* datastores based off a set of discovered disks.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vsphere from "@pulumi/vsphere";
*
* const datacenter = vsphere.getDatacenter({
* name: "dc-01",
* });
* const host = datacenter.then(datacenter => vsphere.getHost({
* name: "esxi-01.example.com",
* datacenterId: datacenter.id,
* }));
* const vmfsDisks = host.then(host => vsphere.getVmfsDisks({
* hostSystemId: host.id,
* rescan: true,
* filter: "mpx.vmhba1:C0:T[12]:L0",
* }));
* ```
*/
export declare function getVmfsDisks(args: GetVmfsDisksArgs, opts?: pulumi.InvokeOptions): Promise<GetVmfsDisksResult>;
/**
* A collection of arguments for invoking getVmfsDisks.
*/
export interface GetVmfsDisksArgs {
/**
* A regular expression to filter the disks against. Only
* disks with canonical names that match will be included.
*
* > **NOTE:** Using a `filter` is recommended if there is any chance the host
* will have any specific storage devices added to it that may affect the order of
* the output `disks` attribute below, which is lexicographically sorted.
*/
filter?: string;
/**
* The managed object ID of
* the host to look for disks on.
*/
hostSystemId: string;
/**
* Whether or not to rescan storage adapters before
* searching for disks. This may lengthen the time it takes to perform the
* search. Default: `false`.
*/
rescan?: boolean;
}
/**
* A collection of values returned by getVmfsDisks.
*/
export interface GetVmfsDisksResult {
/**
* A lexicographically sorted list of devices discovered by the
* operation, matching the supplied `filter`, if provided.
*/
readonly disks: string[];
readonly filter?: string;
readonly hostSystemId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly rescan?: boolean;
}
/**
* The `vsphere.getVmfsDisks` data source can be used to discover the storage
* devices available on an ESXi host. This data source can be combined with the
* `vsphere.VmfsDatastore` resource to create VMFS
* datastores based off a set of discovered disks.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vsphere from "@pulumi/vsphere";
*
* const datacenter = vsphere.getDatacenter({
* name: "dc-01",
* });
* const host = datacenter.then(datacenter => vsphere.getHost({
* name: "esxi-01.example.com",
* datacenterId: datacenter.id,
* }));
* const vmfsDisks = host.then(host => vsphere.getVmfsDisks({
* hostSystemId: host.id,
* rescan: true,
* filter: "mpx.vmhba1:C0:T[12]:L0",
* }));
* ```
*/
export declare function getVmfsDisksOutput(args: GetVmfsDisksOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVmfsDisksResult>;
/**
* A collection of arguments for invoking getVmfsDisks.
*/
export interface GetVmfsDisksOutputArgs {
/**
* A regular expression to filter the disks against. Only
* disks with canonical names that match will be included.
*
* > **NOTE:** Using a `filter` is recommended if there is any chance the host
* will have any specific storage devices added to it that may affect the order of
* the output `disks` attribute below, which is lexicographically sorted.
*/
filter?: pulumi.Input<string>;
/**
* The managed object ID of
* the host to look for disks on.
*/
hostSystemId: pulumi.Input<string>;
/**
* Whether or not to rescan storage adapters before
* searching for disks. This may lengthen the time it takes to perform the
* search. Default: `false`.
*/
rescan?: pulumi.Input<boolean>;
}