vSphere v4.9.0, Nov 28 23

vSphere v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

vsphere.VmfsDatastore

Explore with Pulumi AI

vSphere v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

Create VmfsDatastore Resource

new VmfsDatastore(name: string, args: VmfsDatastoreArgs, opts?: CustomResourceOptions);

@overload
def VmfsDatastore(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  custom_attributes: Optional[Mapping[str, str]] = None,
                  datastore_cluster_id: Optional[str] = None,
                  disks: Optional[Sequence[str]] = None,
                  folder: Optional[str] = None,
                  host_system_id: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Sequence[str]] = None)
@overload
def VmfsDatastore(resource_name: str,
                  args: VmfsDatastoreArgs,
                  opts: Optional[ResourceOptions] = None)

func NewVmfsDatastore(ctx *Context, name string, args VmfsDatastoreArgs, opts ...ResourceOption) (*VmfsDatastore, error)

public VmfsDatastore(string name, VmfsDatastoreArgs args, CustomResourceOptions? opts = null)

public VmfsDatastore(String name, VmfsDatastoreArgs args)
public VmfsDatastore(String name, VmfsDatastoreArgs args, CustomResourceOptions options)

type: vsphere:VmfsDatastore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VmfsDatastoreArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VmfsDatastoreArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VmfsDatastoreArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VmfsDatastoreArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VmfsDatastoreArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

VmfsDatastore Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The VmfsDatastore resource accepts the following input properties:

Disks List<string>: The disks to use with the datastore.
HostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
CustomAttributes Dictionary<string, string>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
DatastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
Folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
Name string: The name of the datastore. Forces a new resource if changed.
Tags List<string>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

Disks []string: The disks to use with the datastore.
HostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
CustomAttributes map[string]string: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
DatastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
Folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
Name string: The name of the datastore. Forces a new resource if changed.
Tags []string: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

disks List<String>: The disks to use with the datastore.
hostSystemId String: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
customAttributes Map<String,String>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId String: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
folder String: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
name String: The name of the datastore. Forces a new resource if changed.
tags List<String>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

disks string[]: The disks to use with the datastore.
hostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
customAttributes {[key: string]: string}: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
name string: The name of the datastore. Forces a new resource if changed.
tags string[]: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

disks Sequence[str]: The disks to use with the datastore.
host_system_id str: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
custom_attributes Mapping[str, str]: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastore_cluster_id str: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
folder str: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
name str: The name of the datastore. Forces a new resource if changed.
tags Sequence[str]: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

disks List<String>: The disks to use with the datastore.
hostSystemId String: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
customAttributes Map<String>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId String: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
folder String: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
name String: The name of the datastore. Forces a new resource if changed.
tags List<String>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.

Outputs

All input properties are implicitly available as output properties. Additionally, the VmfsDatastore resource produces the following output properties:

Accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
Capacity int: Maximum capacity of the datastore, in megabytes.
FreeSpace int: Available space of this datastore, in megabytes.
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceMode string: The current maintenance mode state of the datastore.
MultipleHostAccess bool: If true, more than one host in the datacenter has been configured with access to the datastore.
UncommittedSpace int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
Url string: The unique locator for the datastore.

Accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
Capacity int: Maximum capacity of the datastore, in megabytes.
FreeSpace int: Available space of this datastore, in megabytes.
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceMode string: The current maintenance mode state of the datastore.
MultipleHostAccess bool: If true, more than one host in the datacenter has been configured with access to the datastore.
UncommittedSpace int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
Url string: The unique locator for the datastore.

accessible Boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity Integer: Maximum capacity of the datastore, in megabytes.
freeSpace Integer: Available space of this datastore, in megabytes.
id String: The provider-assigned unique ID for this managed resource.
maintenanceMode String: The current maintenance mode state of the datastore.
multipleHostAccess Boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
uncommittedSpace Integer: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url String: The unique locator for the datastore.

accessible boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity number: Maximum capacity of the datastore, in megabytes.
freeSpace number: Available space of this datastore, in megabytes.
id string: The provider-assigned unique ID for this managed resource.
maintenanceMode string: The current maintenance mode state of the datastore.
multipleHostAccess boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
uncommittedSpace number: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url string: The unique locator for the datastore.

accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity int: Maximum capacity of the datastore, in megabytes.
free_space int: Available space of this datastore, in megabytes.
id str: The provider-assigned unique ID for this managed resource.
maintenance_mode str: The current maintenance mode state of the datastore.
multiple_host_access bool: If true, more than one host in the datacenter has been configured with access to the datastore.
uncommitted_space int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url str: The unique locator for the datastore.

accessible Boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity Number: Maximum capacity of the datastore, in megabytes.
freeSpace Number: Available space of this datastore, in megabytes.
id String: The provider-assigned unique ID for this managed resource.
maintenanceMode String: The current maintenance mode state of the datastore.
multipleHostAccess Boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
uncommittedSpace Number: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url String: The unique locator for the datastore.

Look up Existing VmfsDatastore Resource

Get an existing VmfsDatastore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VmfsDatastoreState, opts?: CustomResourceOptions): VmfsDatastore

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessible: Optional[bool] = None,
        capacity: Optional[int] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        datastore_cluster_id: Optional[str] = None,
        disks: Optional[Sequence[str]] = None,
        folder: Optional[str] = None,
        free_space: Optional[int] = None,
        host_system_id: Optional[str] = None,
        maintenance_mode: Optional[str] = None,
        multiple_host_access: Optional[bool] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        uncommitted_space: Optional[int] = None,
        url: Optional[str] = None) -> VmfsDatastore

func GetVmfsDatastore(ctx *Context, name string, id IDInput, state *VmfsDatastoreState, opts ...ResourceOption) (*VmfsDatastore, error)

public static VmfsDatastore Get(string name, Input<string> id, VmfsDatastoreState? state, CustomResourceOptions? opts = null)

public static VmfsDatastore get(String name, Output<String> id, VmfsDatastoreState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
Capacity int: Maximum capacity of the datastore, in megabytes.
CustomAttributes Dictionary<string, string>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
DatastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
Disks List<string>: The disks to use with the datastore.
Folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
FreeSpace int: Available space of this datastore, in megabytes.
HostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
MaintenanceMode string: The current maintenance mode state of the datastore.
MultipleHostAccess bool: If true, more than one host in the datacenter has been configured with access to the datastore.
Name string: The name of the datastore. Forces a new resource if changed.
Tags List<string>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
UncommittedSpace int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
Url string: The unique locator for the datastore.

Accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
Capacity int: Maximum capacity of the datastore, in megabytes.
CustomAttributes map[string]string: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
DatastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
Disks []string: The disks to use with the datastore.
Folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
FreeSpace int: Available space of this datastore, in megabytes.
HostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
MaintenanceMode string: The current maintenance mode state of the datastore.
MultipleHostAccess bool: If true, more than one host in the datacenter has been configured with access to the datastore.
Name string: The name of the datastore. Forces a new resource if changed.
Tags []string: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
UncommittedSpace int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
Url string: The unique locator for the datastore.

accessible Boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity Integer: Maximum capacity of the datastore, in megabytes.
customAttributes Map<String,String>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId String: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
disks List<String>: The disks to use with the datastore.
folder String: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
freeSpace Integer: Available space of this datastore, in megabytes.
hostSystemId String: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
maintenanceMode String: The current maintenance mode state of the datastore.
multipleHostAccess Boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
name String: The name of the datastore. Forces a new resource if changed.
tags List<String>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
uncommittedSpace Integer: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url String: The unique locator for the datastore.

accessible boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity number: Maximum capacity of the datastore, in megabytes.
customAttributes {[key: string]: string}: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId string: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
disks string[]: The disks to use with the datastore.
folder string: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
freeSpace number: Available space of this datastore, in megabytes.
hostSystemId string: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
maintenanceMode string: The current maintenance mode state of the datastore.
multipleHostAccess boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
name string: The name of the datastore. Forces a new resource if changed.
tags string[]: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
uncommittedSpace number: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url string: The unique locator for the datastore.

accessible bool: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity int: Maximum capacity of the datastore, in megabytes.
custom_attributes Mapping[str, str]: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastore_cluster_id str: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
disks Sequence[str]: The disks to use with the datastore.
folder str: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
free_space int: Available space of this datastore, in megabytes.
host_system_id str: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
maintenance_mode str: The current maintenance mode state of the datastore.
multiple_host_access bool: If true, more than one host in the datacenter has been configured with access to the datastore.
name str: The name of the datastore. Forces a new resource if changed.
tags Sequence[str]: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
uncommitted_space int: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url str: The unique locator for the datastore.

accessible Boolean: The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
capacity Number: Maximum capacity of the datastore, in megabytes.
customAttributes Map<String>: Map of custom attribute ids to attribute value string to set on datastore resource.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.
datastoreClusterId String: The managed object ID of a datastore cluster to put this datastore in. Conflicts with folder.
disks List<String>: The disks to use with the datastore.
folder String: The relative path to a folder to put this datastore in. This is a path relative to the datacenter you are deploying the datastore to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a datastore named test in a datastore folder located at /dc1/datastore/foo/bar, with the final inventory path being /dc1/datastore/foo/bar/test. Conflicts with datastore_cluster_id.
freeSpace Number: Available space of this datastore, in megabytes.
hostSystemId String: The managed object ID of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
maintenanceMode String: The current maintenance mode state of the datastore.
multipleHostAccess Boolean: If true, more than one host in the datacenter has been configured with access to the datastore.
name String: The name of the datastore. Forces a new resource if changed.
tags List<String>: The IDs of any tags to attach to this resource.
NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
uncommittedSpace Number: Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
url String: The unique locator for the datastore.

Package Details

Repository: vSphere pulumi/pulumi-vsphere
License: Apache-2.0
Notes: This Pulumi package is based on the vsphere Terraform Provider.

vSphere v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

pulumi/pulumi-vsphere

vsphere.VmfsDatastore

On this page

On this page

Create VmfsDatastore Resource

VmfsDatastore Resource Properties

Inputs

Outputs

Look up Existing VmfsDatastore Resource

Package Details

On this page

On this page