LibraryStorageBacking

The StorageBacking structure defines a storage location where content in a library will be stored. The storage location can either be a Datastore or Other type.


Properties

string
datastore_id Optional

Identifier of the datastore used to store the content in the library. This field is optional and it is only relevant when the value of StorageBacking.type is DATASTORE. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datastore. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datastore.


string as uri
storage_uri Optional

URI identifying the location used to store the content in the library. The following URI formats are supported:

vSphere 6.5

  • nfs://server/path?version=4 (for vCenter Server Appliance only) - Specifies an NFS Version 4 server.
  • nfs://server/path (for vCenter Server Appliance only) - Specifies an NFS Version 3 server. The nfs://server:/path format is also supported.
  • smb://server/path - Specifies an SMB server or Windows share.

vSphere 6.0 Update 1

  • nfs://server:/path (for vCenter Server Appliance only)
  • file://unc-server/path (for vCenter Server for Windows only)
  • file:///mount/point (for vCenter Server Appliance only) - Local file URIs are supported only when the path is a local mount point for an NFS file system. Use of file URIs is strongly discouraged. Instead, use an NFS URI to specify the remote file system.

vSphere 6.0

  • nfs://server:/path (for vCenter Server Appliance only)
  • file://unc-server/path (for vCenter Server for Windows only)
  • file:///path - Local file URIs are supported but strongly discouraged because it may interfere with the performance of vCenter Server.

This field is optional and it is only relevant when the value of StorageBacking.type is OTHER.


type Optional

The StorageBacking.Type enumerated type specifies the type of the StorageBacking.
DATASTORE : The content of the library will be stored on a datastore. These are vCenter Server managed datastores, and are logical containers that hide specifics of each storage device. Depending on the type of storage you use, datastores can be backed by the following file system formats:

  • Virtual Machine File System (VMFS)
  • Network File System (NFS)


OTHER : The content of the library will be stored on a remote file system. Supports the following remote file systems:

  • NFS (on vCenter Server Appliance)
  • SMB (on vCenter Server Appliance and vCenter Server for Windows)

Possible values are: DATASTOREOTHER

JSON Example

{
	"datastore_id": "string",
	"storage_uri": "string",
	"type": "DATASTORE"
}

Feedback

Was this page helpful?