VmfsDatastore
Create a VmfsDatastore Resource
new VmfsDatastore(name: string, args: VmfsDatastoreArgs, opts?: CustomResourceOptions);
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)
func NewVmfsDatastore(ctx *Context, name string, args VmfsDatastoreArgs, opts ...ResourceOption) (*VmfsDatastore, error)
public VmfsDatastore(string name, VmfsDatastoreArgs args, CustomResourceOptions? opts = null)
- 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.
- opts ResourceOptions
- A bag of options that control this 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.
VmfsDatastore Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The VmfsDatastore resource accepts the following input properties:
- Disks List<string>
The disks to use with the datastore.
- Host
System stringId 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 Dictionary<string, string> Map of custom attribute ids to attribute value string to set on datastore resource.
- Datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- Name string
The name of the datastore. Forces a new resource if changed.
- List<string>
The IDs of any tags to attach to this resource.
- Disks []string
The disks to use with the datastore.
- Host
System stringId 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 map[string]string Map of custom attribute ids to attribute value string to set on datastore resource.
- Datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- Name string
The name of the datastore. Forces a new resource if changed.
- []string
The IDs of any tags to attach to this resource.
- disks string[]
The disks to use with the datastore.
- host
System stringId 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 {[key: string]: string} Map of custom attribute ids to attribute value string to set on datastore resource.
- datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- name string
The name of the datastore. Forces a new resource if changed.
- string[]
The IDs of any tags to attach to this resource.
- disks Sequence[str]
The disks to use with the datastore.
- host_
system_ strid 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.
- datastore_
cluster_ strid 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- name str
The name of the datastore. Forces a new resource if changed.
- Sequence[str]
The IDs of any tags to attach to this resource.
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.
- Free
Space int Available space of this datastore, in megabytes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Mode string The current maintenance mode state of the datastore.
- Multiple
Host boolAccess 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 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 string
- The provider-assigned unique ID for this managed resource.
- Maintenance
Mode string The current maintenance mode state of the datastore.
- Multiple
Host boolAccess 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 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.
- free
Space number Available space of this datastore, in megabytes.
- id string
- The provider-assigned unique ID for this managed resource.
- maintenance
Mode string The current maintenance mode state of the datastore.
- multiple
Host booleanAccess If
true
, more than one host in the datacenter has been configured with access to the datastore.- uncommitted
Space 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_ boolaccess 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.
Look up an 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)
- 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.
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.
- Custom
Attributes Dictionary<string, string> Map of custom attribute ids to attribute value string to set on datastore resource.
- Datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- Free
Space int Available space of this datastore, in megabytes.
- Host
System stringId 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 string The current maintenance mode state of the datastore.
- Multiple
Host boolAccess 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.
- List<string>
The IDs of any tags to attach to this resource.
- Uncommitted
Space 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.
- Custom
Attributes map[string]string Map of custom attribute ids to attribute value string to set on datastore resource.
- Datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- Free
Space int Available space of this datastore, in megabytes.
- Host
System stringId 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 string The current maintenance mode state of the datastore.
- Multiple
Host boolAccess 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.
- []string
The IDs of any tags to attach to this resource.
- Uncommitted
Space 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 number
Maximum capacity of the datastore, in megabytes.
- custom
Attributes {[key: string]: string} Map of custom attribute ids to attribute value string to set on datastore resource.
- datastore
Cluster stringId 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- free
Space number Available space of this datastore, in megabytes.
- host
System stringId 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 string The current maintenance mode state of the datastore.
- multiple
Host booleanAccess 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.
- string[]
The IDs of any tags to attach to this resource.
- uncommitted
Space 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.
- datastore_
cluster_ strid 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 providedfolder
offoo/bar
, The provider will place a datastore namedtest
in a datastore folder located at/dc1/datastore/foo/bar
, with the final inventory path being/dc1/datastore/foo/bar/test
. Conflicts withdatastore_cluster_id
.- free_
space int Available space of this datastore, in megabytes.
- host_
system_ strid 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_ boolaccess 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.
- Sequence[str]
The IDs of any tags to attach to this resource.
- 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.
Package Details
- Repository
- https://github.com/pulumi/pulumi-vsphere
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vsphere
Terraform Provider.