types

package
v0.39.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2024 License: Apache-2.0 Imports: 3 Imported by: 7

Documentation

Index

Constants

View Source
const (
	// Event type used to notify that FCD is going to be relocated.
	VslmEventTypePreFcdMigrateEvent = VslmEventType("preFcdMigrateEvent")
	// Event type used to notify FCD has been relocated.
	VslmEventTypePostFcdMigrateEvent = VslmEventType("postFcdMigrateEvent")
)
View Source
const (
	// When the event has been successfully processed.
	VslmEventVslmEventInfoStateSuccess = VslmEventVslmEventInfoState("success")
	// When there is error while processing the event.
	VslmEventVslmEventInfoStateError = VslmEventVslmEventInfoState("error")
)
View Source
const (
	// When there are too many tasks for threads to handle.
	VslmTaskInfoStateQueued = VslmTaskInfoState("queued")
	// When the busy thread is freed from its current task by
	// finishing the task, it picks a queued task to run.
	//
	// Then the queued tasks are marked as running.
	VslmTaskInfoStateRunning = VslmTaskInfoState("running")
	// When a running task has completed.
	VslmTaskInfoStateSuccess = VslmTaskInfoState("success")
	// When a running task has encountered an error.
	VslmTaskInfoStateError = VslmTaskInfoState("error")
)
View Source
const (
	// Indicates `BaseConfigInfo.id` as the searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumId = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("id")
	// Indicates `BaseConfigInfo.name` as the searchable
	// field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumName = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("name")
	// Indicates `VStorageObjectConfigInfo.capacityInMB` as the
	// searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumCapacity = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("capacity")
	// Indicates `BaseConfigInfo.createTime` as the searchable
	// field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumCreateTime = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("createTime")
	// Indicates
	// `BaseConfigInfoFileBackingInfo.backingObjectId` as the
	// searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumBackingObjectId = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("backingObjectId")
	// Indicates `BaseConfigInfoBackingInfo.datastore` as the
	// searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumDatastoreMoId = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("datastoreMoId")
	// Indicates it as the searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumMetadataKey = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("metadataKey")
	// Indicates it as the searchable field.
	VslmVsoVStorageObjectQuerySpecQueryFieldEnumMetadataValue = VslmVsoVStorageObjectQuerySpecQueryFieldEnum("metadataValue")
)
View Source
const (
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumEquals             = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("equals")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumNotEquals          = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("notEquals")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumLessThan           = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("lessThan")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumGreaterThan        = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("greaterThan")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumLessThanOrEqual    = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("lessThanOrEqual")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumGreaterThanOrEqual = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("greaterThanOrEqual")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumContains           = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("contains")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumStartsWith         = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("startsWith")
	VslmVsoVStorageObjectQuerySpecQueryOperatorEnumEndsWith           = VslmVsoVStorageObjectQuerySpecQueryOperatorEnum("endsWith")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ArrayOfVslmDatastoreSyncStatus

type ArrayOfVslmDatastoreSyncStatus struct {
	VslmDatastoreSyncStatus []VslmDatastoreSyncStatus `xml:"VslmDatastoreSyncStatus,omitempty" json:"_value"`
}

A boxed array of `VslmDatastoreSyncStatus`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmQueryDatastoreInfoResult

type ArrayOfVslmQueryDatastoreInfoResult struct {
	VslmQueryDatastoreInfoResult []VslmQueryDatastoreInfoResult `xml:"VslmQueryDatastoreInfoResult,omitempty" json:"_value"`
}

A boxed array of `VslmQueryDatastoreInfoResult`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmVsoVStorageObjectAssociations

type ArrayOfVslmVsoVStorageObjectAssociations struct {
	VslmVsoVStorageObjectAssociations []VslmVsoVStorageObjectAssociations `xml:"VslmVsoVStorageObjectAssociations,omitempty" json:"_value"`
}

A boxed array of `VslmVsoVStorageObjectAssociations`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmVsoVStorageObjectAssociationsVmDiskAssociation

type ArrayOfVslmVsoVStorageObjectAssociationsVmDiskAssociation struct {
	VslmVsoVStorageObjectAssociationsVmDiskAssociation []VslmVsoVStorageObjectAssociationsVmDiskAssociation `xml:"VslmVsoVStorageObjectAssociationsVmDiskAssociation,omitempty" json:"_value"`
}

A boxed array of `VslmVsoVStorageObjectAssociationsVmDiskAssociation`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmVsoVStorageObjectQuerySpec

type ArrayOfVslmVsoVStorageObjectQuerySpec struct {
	VslmVsoVStorageObjectQuerySpec []VslmVsoVStorageObjectQuerySpec `xml:"VslmVsoVStorageObjectQuerySpec,omitempty" json:"_value"`
}

A boxed array of `VslmVsoVStorageObjectQuerySpec`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmVsoVStorageObjectResult

type ArrayOfVslmVsoVStorageObjectResult struct {
	VslmVsoVStorageObjectResult []VslmVsoVStorageObjectResult `xml:"VslmVsoVStorageObjectResult,omitempty" json:"_value"`
}

A boxed array of `VslmVsoVStorageObjectResult`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type ArrayOfVslmVsoVStorageObjectSnapshotResult added in v0.22.0

type ArrayOfVslmVsoVStorageObjectSnapshotResult struct {
	VslmVsoVStorageObjectSnapshotResult []VslmVsoVStorageObjectSnapshotResult `xml:"VslmVsoVStorageObjectSnapshotResult,omitempty" json:"_value"`
}

A boxed array of `VslmVsoVStorageObjectSnapshotResult`. To be used in `Any` placeholders.

This structure may be used only with operations rendered under `/vslm`.

type BaseVslmFault

type BaseVslmFault interface {
	GetVslmFault() *VslmFault
}

type BaseVslmTaskReason

type BaseVslmTaskReason interface {
	GetVslmTaskReason() *VslmTaskReason
}

type RetrieveContent

type RetrieveContent RetrieveContentRequestType

type RetrieveContentRequestType

type RetrieveContentRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type RetrieveContentResponse

type RetrieveContentResponse struct {
	Returnval VslmServiceInstanceContent `xml:"returnval" json:"returnval"`
}

type VersionURI

type VersionURI string

type VslmAboutInfo

type VslmAboutInfo struct {
	types.DynamicData

	Name         string `xml:"name" json:"name"`
	FullName     string `xml:"fullName" json:"fullName"`
	Vendor       string `xml:"vendor" json:"vendor"`
	ApiVersion   string `xml:"apiVersion" json:"apiVersion"`
	InstanceUuid string `xml:"instanceUuid" json:"instanceUuid"`
}

This data object type describes system information.

This structure may be used only with operations rendered under `/vslm`.

type VslmAttachDiskRequestType

type VslmAttachDiskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual disk to be operated. See
	// `ID`
	Id types.ID `xml:"id" json:"id"`
	// The virtual machine where the virtual disk is to be attached.
	//
	// Refers instance of `VirtualMachine`.
	Vm types.ManagedObjectReference `xml:"vm" json:"vm"`
	// Key of the controller the disk will connect to.
	// It can be unset if there is only one controller
	// (SCSI or SATA) with the available slot in the
	// virtual machine. If there are multiple SCSI or
	// SATA controllers available, user must specify
	// the controller; if there is no available
	// controllers, a `MissingController`
	// fault will be thrown.
	ControllerKey int32 `xml:"controllerKey,omitempty" json:"controllerKey,omitempty"`
	// The unit number of the attached disk on its controller.
	// If unset, the next available slot on the specified
	// controller or the only available controller will be
	// assigned to the attached disk.
	UnitNumber *int32 `xml:"unitNumber" json:"unitNumber,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmAttachDisk_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmAttachDisk_Task

type VslmAttachDisk_Task VslmAttachDiskRequestType

type VslmAttachDisk_TaskResponse

type VslmAttachDisk_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmAttachTagToVStorageObjectRequestType

type VslmAttachTagToVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The identifier(ID) of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The category to which the tag belongs.
	Category string `xml:"category" json:"category"`
	// The tag which has to be associated with the virtual storage
	// object.
	Tag string `xml:"tag" json:"tag"`
}

The parameters of `VslmVStorageObjectManager.VslmAttachTagToVStorageObject`.

This structure may be used only with operations rendered under `/vslm`.

type VslmAttachTagToVStorageObjectResponse

type VslmAttachTagToVStorageObjectResponse struct {
}

type VslmCancelTask

type VslmCancelTask VslmCancelTaskRequestType

type VslmCancelTaskRequestType

type VslmCancelTaskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type VslmCancelTaskResponse

type VslmCancelTaskResponse struct {
}

type VslmClearVStorageObjectControlFlagsRequestType

type VslmClearVStorageObjectControlFlagsRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// control flags enum array to be cleared on the
	// VStorageObject. All control flags not included
	// in the array remain intact.
	ControlFlags []string `xml:"controlFlags,omitempty" json:"controlFlags,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmClearVStorageObjectControlFlags`.

This structure may be used only with operations rendered under `/vslm`.

type VslmClearVStorageObjectControlFlagsResponse

type VslmClearVStorageObjectControlFlagsResponse struct {
}

type VslmCloneVStorageObjectRequestType

type VslmCloneVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The specification for cloning the virtual storage
	// object.
	Spec types.VslmCloneSpec `xml:"spec" json:"spec"`
}

The parameters of `VslmVStorageObjectManager.VslmCloneVStorageObject_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmCloneVStorageObject_Task

type VslmCloneVStorageObject_Task VslmCloneVStorageObjectRequestType

type VslmCloneVStorageObject_TaskResponse

type VslmCloneVStorageObject_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmCreateDiskFromSnapshotRequestType

type VslmCreateDiskFromSnapshotRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of the virtual storage object.
	SnapshotId types.ID `xml:"snapshotId" json:"snapshotId"`
	// A user friendly name to be associated with the new disk.
	Name string `xml:"name" json:"name"`
	// SPBM Profile requirement on the new virtual storage object.
	// If not specified datastore default policy would be
	// assigned.
	Profile []types.VirtualMachineProfileSpec `xml:"profile,omitempty" json:"profile,omitempty"`
	// Crypto information of the new disk.
	Crypto *types.CryptoSpec `xml:"crypto,omitempty" json:"crypto,omitempty"`
	// Relative location in the specified datastore where disk needs
	// to be created. If not specified disk gets created at the
	// defualt VStorageObject location on the specified datastore.
	Path string `xml:"path,omitempty" json:"path,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmCreateDiskFromSnapshot_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmCreateDiskFromSnapshot_TaskResponse

type VslmCreateDiskFromSnapshot_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmCreateDiskRequestType

type VslmCreateDiskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The specification of the virtual storage object
	// to be created.
	Spec types.VslmCreateSpec `xml:"spec" json:"spec"`
}

The parameters of `VslmVStorageObjectManager.VslmCreateDisk_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmCreateDisk_Task

type VslmCreateDisk_Task VslmCreateDiskRequestType

type VslmCreateDisk_TaskResponse

type VslmCreateDisk_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmCreateSnapshotRequestType

type VslmCreateSnapshotRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// A short description to be associated with the snapshot.
	Description string `xml:"description" json:"description"`
}

The parameters of `VslmVStorageObjectManager.VslmCreateSnapshot_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmCreateSnapshot_Task

type VslmCreateSnapshot_Task VslmCreateSnapshotRequestType

type VslmCreateSnapshot_TaskResponse

type VslmCreateSnapshot_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmDatastoreSyncStatus

type VslmDatastoreSyncStatus struct {
	types.DynamicData

	// The datastore URL as specified in `DatastoreInfo.url`
	DatastoreURL string `xml:"datastoreURL" json:"datastoreURL"`
	ObjectVClock int64  `xml:"objectVClock" json:"objectVClock"`
	SyncVClock   int64  `xml:"syncVClock" json:"syncVClock"`
	// The time representing the last successfull sync of the datastore.
	SyncTime *time.Time `xml:"syncTime" json:"syncTime,omitempty"`
	// The number of retries for the Datastore synchronization in failure
	// cases.
	NumberOfRetries int32 `xml:"numberOfRetries,omitempty" json:"numberOfRetries,omitempty"`
	// The fault is set in case of error conditions.
	//
	// If the fault is set,
	// the objectVClock and syncVClock will be set to -1L.
	// Possible Faults:
	// SyncFault If specified datastoreURL failed to sync.
	Error *types.LocalizedMethodFault `xml:"error,omitempty" json:"error,omitempty"`
}

DatastoreSyncStatus shows the catalog sync status of a datastore and is returned as a result of the VStorageObjectManager getGlobalCatalogSyncStatus API.

When syncVClock == objectVClock the global catalog is in sync with the local catalog

This structure may be used only with operations rendered under `/vslm`.

type VslmDeleteSnapshotRequestType

type VslmDeleteSnapshotRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of a virtual storage object.
	SnapshotId types.ID `xml:"snapshotId" json:"snapshotId"`
}

The parameters of `VslmVStorageObjectManager.VslmDeleteSnapshot_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmDeleteSnapshot_Task

type VslmDeleteSnapshot_Task VslmDeleteSnapshotRequestType

type VslmDeleteSnapshot_TaskResponse

type VslmDeleteSnapshot_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmDeleteVStorageObjectRequestType

type VslmDeleteVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object to be deleted.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmDeleteVStorageObject_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmDeleteVStorageObject_Task

type VslmDeleteVStorageObject_Task VslmDeleteVStorageObjectRequestType

type VslmDeleteVStorageObject_TaskResponse

type VslmDeleteVStorageObject_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmDetachTagFromVStorageObjectRequestType

type VslmDetachTagFromVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The identifier(ID) of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The category to which the tag belongs.
	Category string `xml:"category" json:"category"`
	// The tag which has to be disassociated with the virtual storage
	// object.
	Tag string `xml:"tag" json:"tag"`
}

The parameters of `VslmVStorageObjectManager.VslmDetachTagFromVStorageObject`.

This structure may be used only with operations rendered under `/vslm`.

type VslmDetachTagFromVStorageObjectResponse

type VslmDetachTagFromVStorageObjectResponse struct {
}

type VslmEventType added in v0.23.0

type VslmEventType string

func (VslmEventType) Strings added in v0.38.0

func (e VslmEventType) Strings() []string

func (VslmEventType) Values added in v0.38.0

func (e VslmEventType) Values() []VslmEventType

type VslmEventVslmEventInfoState added in v0.23.0

type VslmEventVslmEventInfoState string

The possible states of the vlsm event processing.

func (VslmEventVslmEventInfoState) Strings added in v0.38.0

func (e VslmEventVslmEventInfoState) Strings() []string

func (VslmEventVslmEventInfoState) Values added in v0.38.0

type VslmExtendDiskRequestType

type VslmExtendDiskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual disk to be extended.
	Id types.ID `xml:"id" json:"id"`
	// The new capacity of the virtual disk in MB.
	NewCapacityInMB int64 `xml:"newCapacityInMB" json:"newCapacityInMB"`
}

The parameters of `VslmVStorageObjectManager.VslmExtendDisk_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmExtendDisk_Task

type VslmExtendDisk_Task VslmExtendDiskRequestType

type VslmExtendDisk_TaskResponse

type VslmExtendDisk_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmFault

type VslmFault struct {
	types.MethodFault

	// The fault message if available.
	Msg string `xml:"msg,omitempty" json:"msg,omitempty"`
}

The super class for all VSLM Faults.

This structure may be used only with operations rendered under `/vslm`.

func (*VslmFault) GetVslmFault

func (b *VslmFault) GetVslmFault() *VslmFault

type VslmFaultFault

type VslmFaultFault BaseVslmFault

type VslmInflateDiskRequestType

type VslmInflateDiskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual disk to be inflated.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmInflateDisk_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmInflateDisk_Task

type VslmInflateDisk_Task VslmInflateDiskRequestType

type VslmInflateDisk_TaskResponse

type VslmInflateDisk_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmListTagsAttachedToVStorageObjectRequestType

type VslmListTagsAttachedToVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmListTagsAttachedToVStorageObject`.

This structure may be used only with operations rendered under `/vslm`.

type VslmListTagsAttachedToVStorageObjectResponse

type VslmListTagsAttachedToVStorageObjectResponse struct {
	Returnval []types.VslmTagEntry `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmListVStorageObjectForSpecRequestType

type VslmListVStorageObjectForSpecRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// Query defined using array of
	// `VslmVsoVStorageObjectQuerySpec` objects.
	Query []VslmVsoVStorageObjectQuerySpec `xml:"query,omitempty" json:"query,omitempty"`
	// Maximum number of virtual storage object IDs to return.
	MaxResult int32 `xml:"maxResult" json:"maxResult"`
}

The parameters of `VslmVStorageObjectManager.VslmListVStorageObjectForSpec`.

This structure may be used only with operations rendered under `/vslm`.

type VslmListVStorageObjectForSpecResponse

type VslmListVStorageObjectForSpecResponse struct {
	Returnval *VslmVsoVStorageObjectQueryResult `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmListVStorageObjectsAttachedToTagRequestType

type VslmListVStorageObjectsAttachedToTagRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The category to which the tag belongs.
	Category string `xml:"category" json:"category"`
	// The tag to be queried.
	Tag string `xml:"tag" json:"tag"`
}

The parameters of `VslmVStorageObjectManager.VslmListVStorageObjectsAttachedToTag`.

This structure may be used only with operations rendered under `/vslm`.

type VslmListVStorageObjectsAttachedToTagResponse

type VslmListVStorageObjectsAttachedToTagResponse struct {
	Returnval []types.ID `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmLoginByToken

type VslmLoginByToken VslmLoginByTokenRequestType

type VslmLoginByTokenRequestType

type VslmLoginByTokenRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The delegated token will be retrieved by the
	// client and delegated to VSLM. VSLM will use this token, on user's
	// behalf, to login to VC for authorization purposes. It is necessary
	// to convert the token to XML because the SAML token itself is
	// not a VMODL Data Object and cannot be used as a parameter.
	DelegatedTokenXml string `xml:"delegatedTokenXml" json:"delegatedTokenXml"`
}

The parameters of `VslmSessionManager.VslmLoginByToken`.

This structure may be used only with operations rendered under `/vslm`.

type VslmLoginByTokenResponse

type VslmLoginByTokenResponse struct {
}

type VslmLogout

type VslmLogout VslmLogoutRequestType

type VslmLogoutRequestType

type VslmLogoutRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type VslmLogoutResponse

type VslmLogoutResponse struct {
}

type VslmQueryChangedDiskAreasRequestType

type VslmQueryChangedDiskAreasRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of a virtual storage object for
	// which changes that have been made since "changeId"
	// should be computed.
	SnapshotId types.ID `xml:"snapshotId" json:"snapshotId"`
	// Start Offset in bytes at which to start computing
	// changes. Typically, callers will make multiple calls
	// to this function, starting with startOffset 0 and then
	// examine the "length" property in the returned
	// DiskChangeInfo structure, repeatedly calling
	// queryChangedDiskAreas until a map for the entire
	// virtual disk has been obtained.
	StartOffset int64 `xml:"startOffset" json:"startOffset"`
	// Identifier referring to a point in the past that should
	// be used as the point in time at which to begin including
	// changes to the disk in the result. A typical use case
	// would be a backup application obtaining a changeId from
	// a virtual disk's backing info when performing a backup.
	// When a subsequent incremental backup is to be performed,
	// this change Id can be used to obtain a list of changed
	// areas on disk.
	ChangeId string `xml:"changeId" json:"changeId"`
}

The parameters of `VslmVStorageObjectManager.VslmQueryChangedDiskAreas`.

This structure may be used only with operations rendered under `/vslm`.

type VslmQueryChangedDiskAreasResponse

type VslmQueryChangedDiskAreasResponse struct {
	Returnval types.DiskChangeInfo `xml:"returnval" json:"returnval"`
}

type VslmQueryDatastoreInfoRequestType

type VslmQueryDatastoreInfoRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The datastore URL as specified in
	// `DatastoreInfo.url`
	DatastoreUrl string `xml:"datastoreUrl" json:"datastoreUrl"`
}

The parameters of `VslmStorageLifecycleManager.VslmQueryDatastoreInfo`.

This structure may be used only with operations rendered under `/vslm`.

type VslmQueryDatastoreInfoResponse

type VslmQueryDatastoreInfoResponse struct {
	Returnval []VslmQueryDatastoreInfoResult `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmQueryDatastoreInfoResult

type VslmQueryDatastoreInfoResult struct {
	types.DynamicData

	// Indicates the datacenter containing the
	// `VslmQueryDatastoreInfoResult.datastore`.
	//
	// Refers instance of `Datacenter`.
	Datacenter types.ManagedObjectReference `xml:"datacenter" json:"datacenter"`
	// Indicates the datastore which is contained within the
	// `VslmQueryDatastoreInfoResult.datacenter`.
	//
	// Refers instance of `Datastore`.
	Datastore types.ManagedObjectReference `xml:"datastore" json:"datastore"`
}

The `VslmQueryDatastoreInfoResult` provides mapping information between `Datacenter` and `Datastore`.

This API is returned as a result of `VslmStorageLifecycleManager.VslmQueryDatastoreInfo` invocation.

This structure may be used only with operations rendered under `/vslm`.

type VslmQueryGlobalCatalogSyncStatusForDatastoreRequestType

type VslmQueryGlobalCatalogSyncStatusForDatastoreRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// URL of the datastore to check synchronization status for
	DatastoreURL string `xml:"datastoreURL" json:"datastoreURL"`
}

The parameters of `VslmVStorageObjectManager.VslmQueryGlobalCatalogSyncStatusForDatastore`.

This structure may be used only with operations rendered under `/vslm`.

type VslmQueryGlobalCatalogSyncStatusForDatastoreResponse

type VslmQueryGlobalCatalogSyncStatusForDatastoreResponse struct {
	Returnval *VslmDatastoreSyncStatus `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmQueryGlobalCatalogSyncStatusRequestType

type VslmQueryGlobalCatalogSyncStatusRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type VslmQueryGlobalCatalogSyncStatusResponse

type VslmQueryGlobalCatalogSyncStatusResponse struct {
	Returnval []VslmDatastoreSyncStatus `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmQueryInfo

type VslmQueryInfo VslmQueryInfoRequestType

type VslmQueryInfoRequestType

type VslmQueryInfoRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type VslmQueryInfoResponse

type VslmQueryInfoResponse struct {
	Returnval VslmTaskInfo `xml:"returnval" json:"returnval"`
}

type VslmQueryTaskResult

type VslmQueryTaskResult VslmQueryTaskResultRequestType

type VslmQueryTaskResultRequestType

type VslmQueryTaskResultRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
}

type VslmQueryTaskResultResponse

type VslmQueryTaskResultResponse struct {
	Returnval types.AnyType `xml:"returnval,omitempty,typeattr" json:"returnval,omitempty"`
}

type VslmReconcileDatastoreInventoryRequestType

type VslmReconcileDatastoreInventoryRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The datastore that needs to be reconciled.
	//
	// Refers instance of `Datastore`.
	Datastore types.ManagedObjectReference `xml:"datastore" json:"datastore"`
}

The parameters of `VslmVStorageObjectManager.VslmReconcileDatastoreInventory_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmReconcileDatastoreInventory_TaskResponse

type VslmReconcileDatastoreInventory_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmRegisterDisk

type VslmRegisterDisk VslmRegisterDiskRequestType

type VslmRegisterDiskRequestType

type VslmRegisterDiskRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// URL path to the virtual disk.
	Path string `xml:"path" json:"path"`
	// The descriptive name of the disk object. If
	// unset the name will be automatically determined
	// from the path. @see vim.vslm.BaseConfigInfo.name
	Name string `xml:"name,omitempty" json:"name,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmRegisterDisk`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRegisterDiskResponse

type VslmRegisterDiskResponse struct {
	Returnval types.VStorageObject `xml:"returnval" json:"returnval"`
}

type VslmRelocateVStorageObjectRequestType

type VslmRelocateVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The specification for relocation of the virtual
	// storage object.
	Spec types.VslmRelocateSpec `xml:"spec" json:"spec"`
}

The parameters of `VslmVStorageObjectManager.VslmRelocateVStorageObject_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRelocateVStorageObject_TaskResponse

type VslmRelocateVStorageObject_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmRenameVStorageObjectRequestType

type VslmRenameVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object to be renamed.
	Id types.ID `xml:"id" json:"id"`
	// The new name for the virtual storage object.
	Name string `xml:"name" json:"name"`
}

The parameters of `VslmVStorageObjectManager.VslmRenameVStorageObject`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRenameVStorageObjectResponse

type VslmRenameVStorageObjectResponse struct {
}

type VslmRetrieveSnapshotDetails added in v0.22.0

type VslmRetrieveSnapshotDetails VslmRetrieveSnapshotDetailsRequestType

type VslmRetrieveSnapshotDetailsRequestType added in v0.22.0

type VslmRetrieveSnapshotDetailsRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of a virtual storage object.
	SnapshotId types.ID `xml:"snapshotId" json:"snapshotId"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveSnapshotDetails`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveSnapshotDetailsResponse added in v0.22.0

type VslmRetrieveSnapshotDetailsResponse struct {
	Returnval types.VStorageObjectSnapshotDetails `xml:"returnval" json:"returnval"`
}

type VslmRetrieveSnapshotInfoRequestType

type VslmRetrieveSnapshotInfoRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveSnapshotInfo`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveSnapshotInfoResponse

type VslmRetrieveSnapshotInfoResponse struct {
	Returnval types.VStorageObjectSnapshotInfo `xml:"returnval" json:"returnval"`
}

type VslmRetrieveVStorageInfrastructureObjectPolicyRequestType

type VslmRetrieveVStorageInfrastructureObjectPolicyRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// Datastore on which policy needs to be retrieved.
	//
	// Refers instance of `Datastore`.
	Datastore types.ManagedObjectReference `xml:"datastore" json:"datastore"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageInfrastructureObjectPolicy`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageInfrastructureObjectPolicyResponse

type VslmRetrieveVStorageInfrastructureObjectPolicyResponse struct {
	Returnval []types.VslmInfrastructureObjectPolicy `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmRetrieveVStorageObjectAssociationsRequestType

type VslmRetrieveVStorageObjectAssociationsRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The IDs of the virtual storage objects of the query.
	Ids []types.ID `xml:"ids,omitempty" json:"ids,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObjectAssociations`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectAssociationsResponse

type VslmRetrieveVStorageObjectAssociationsResponse struct {
	Returnval []VslmVsoVStorageObjectAssociations `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmRetrieveVStorageObjectMetadataRequestType

type VslmRetrieveVStorageObjectMetadataRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of virtual storage object.
	SnapshotId *types.ID `xml:"snapshotId,omitempty" json:"snapshotId,omitempty"`
	// The prefix of the metadata key that needs to be retrieved
	Prefix string `xml:"prefix,omitempty" json:"prefix,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObjectMetadata`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectMetadataResponse

type VslmRetrieveVStorageObjectMetadataResponse struct {
	Returnval []types.KeyValue `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmRetrieveVStorageObjectMetadataValueRequestType

type VslmRetrieveVStorageObjectMetadataValueRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of virtual storage object.
	SnapshotId *types.ID `xml:"snapshotId,omitempty" json:"snapshotId,omitempty"`
	// The key for the the virtual storage object
	Key string `xml:"key" json:"key"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObjectMetadataValue`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectMetadataValueResponse

type VslmRetrieveVStorageObjectMetadataValueResponse struct {
	Returnval string `xml:"returnval" json:"returnval"`
}

type VslmRetrieveVStorageObjectRequestType

type VslmRetrieveVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object to be retrieved.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObject`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectResponse

type VslmRetrieveVStorageObjectResponse struct {
	Returnval types.VStorageObject `xml:"returnval" json:"returnval"`
}

type VslmRetrieveVStorageObjectStateRequestType

type VslmRetrieveVStorageObjectStateRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object the state to be retrieved.
	Id types.ID `xml:"id" json:"id"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObjectState`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectStateResponse

type VslmRetrieveVStorageObjectStateResponse struct {
	Returnval types.VStorageObjectStateInfo `xml:"returnval" json:"returnval"`
}

type VslmRetrieveVStorageObjectsRequestType

type VslmRetrieveVStorageObjectsRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The array of IDs of the virtual storage object to be
	// retrieved.
	Ids []types.ID `xml:"ids,omitempty" json:"ids,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmRetrieveVStorageObjects`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRetrieveVStorageObjectsResponse

type VslmRetrieveVStorageObjectsResponse struct {
	Returnval []VslmVsoVStorageObjectResult `xml:"returnval,omitempty" json:"returnval,omitempty"`
}

type VslmRevertVStorageObjectRequestType

type VslmRevertVStorageObjectRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// The ID of the snapshot of a virtual storage object.
	SnapshotId types.ID `xml:"snapshotId" json:"snapshotId"`
}

The parameters of `VslmVStorageObjectManager.VslmRevertVStorageObject_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmRevertVStorageObject_Task

type VslmRevertVStorageObject_Task VslmRevertVStorageObjectRequestType

type VslmRevertVStorageObject_TaskResponse

type VslmRevertVStorageObject_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmScheduleReconcileDatastoreInventoryRequestType

type VslmScheduleReconcileDatastoreInventoryRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The datastore that needs to be reconciled.
	//
	// Refers instance of `Datastore`.
	Datastore types.ManagedObjectReference `xml:"datastore" json:"datastore"`
}

The parameters of `VslmVStorageObjectManager.VslmScheduleReconcileDatastoreInventory`.

This structure may be used only with operations rendered under `/vslm`.

type VslmScheduleReconcileDatastoreInventoryResponse

type VslmScheduleReconcileDatastoreInventoryResponse struct {
}

type VslmServiceInstanceContent

type VslmServiceInstanceContent struct {
	types.DynamicData

	// Contains information that identifies the Storage Lifecycle Management
	// service.
	AboutInfo VslmAboutInfo `xml:"aboutInfo" json:"aboutInfo"`
	// `VslmSessionManager` contains login APIs to connect to VSLM
	// service.
	//
	// Refers instance of `VslmSessionManager`.
	SessionManager types.ManagedObjectReference `xml:"sessionManager" json:"sessionManager"`
	// `VslmVStorageObjectManager` contains virtual storage object
	// APIs.
	//
	// Refers instance of `VslmVStorageObjectManager`.
	VStorageObjectManager types.ManagedObjectReference `xml:"vStorageObjectManager" json:"vStorageObjectManager"`
	// `VslmStorageLifecycleManager` contains callback APIs to VSLM
	// service.
	//
	// Refers instance of `VslmStorageLifecycleManager`.
	StorageLifecycleManager types.ManagedObjectReference `xml:"storageLifecycleManager" json:"storageLifecycleManager"`
}

The `VslmServiceInstanceContent` data object defines properties for the `VslmServiceInstance` managed object.

This structure may be used only with operations rendered under `/vslm`.

type VslmSetVStorageObjectControlFlagsRequestType

type VslmSetVStorageObjectControlFlagsRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// control flags enum array to be set on the
	// VStorageObject. All control flags not included
	// in the array remain intact.
	ControlFlags []string `xml:"controlFlags,omitempty" json:"controlFlags,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmSetVStorageObjectControlFlags`.

This structure may be used only with operations rendered under `/vslm`.

type VslmSetVStorageObjectControlFlagsResponse

type VslmSetVStorageObjectControlFlagsResponse struct {
}

type VslmSyncDatastore

type VslmSyncDatastore VslmSyncDatastoreRequestType

type VslmSyncDatastoreRequestType

type VslmSyncDatastoreRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The datastore URL as specified in
	// `DatastoreInfo.url`
	DatastoreUrl string `xml:"datastoreUrl" json:"datastoreUrl"`
	// If this is set to true, all information for this datastore
	// will be discarded from the catalog and reloaded from the
	// datastore's catalog
	FullSync bool `xml:"fullSync" json:"fullSync"`
	// If set, this call blocks until fcdId is persisited into db
	// if this fcdId is not found in queue, assume persisted and return
	FcdId *types.ID `xml:"fcdId,omitempty" json:"fcdId,omitempty"`
}

The parameters of `VslmStorageLifecycleManager.VslmSyncDatastore`.

This structure may be used only with operations rendered under `/vslm`.

type VslmSyncDatastoreResponse

type VslmSyncDatastoreResponse struct {
}

type VslmSyncFault

type VslmSyncFault struct {
	VslmFault

	Id *types.ID `xml:"id,omitempty" json:"id,omitempty"`
}

An SyncFault fault is thrown when there is a failure to synchronize the FCD global catalog information with the local catalog information.

Pandora synchronizes the datastore periodically in the background, it recovers from any transient failures affecting the datastore or individual FCDs. In cases where the sync fault needs to be resolved immediately, explicitly triggering a `VslmStorageLifecycleManager.VslmSyncDatastore` should resolve the issue, unless there are underlying infrastructure issues affecting the datastore or FCD. If the fault is ignored there is a possibility that the FCD is unrecognized by Pandora or Pandora DB having stale information, consequently, affecting the return of `VslmVStorageObjectManager.VslmListVStorageObjectForSpec` and `VslmVStorageObjectManager.VslmRetrieveVStorageObjects` APIs. In cases where the `VslmSyncFault.id` is specified, the client can explicitly trigger `VslmStorageLifecycleManager.VslmSyncDatastore` to resolve the issue, else, could ignore the fault in anticipation of Pandora automatically resolving the error.

This structure may be used only with operations rendered under `/vslm`.

type VslmSyncFaultFault

type VslmSyncFaultFault VslmSyncFault

type VslmTaskInfo

type VslmTaskInfo struct {
	types.DynamicData

	// The unique key for the task.
	Key string `xml:"key" json:"key"`
	// The managed object that represents this task.
	//
	// Refers instance of `VslmTask`.
	Task types.ManagedObjectReference `xml:"task" json:"task"`
	// The description field of the task describes the current phase of
	// operation of the task.
	//
	// For a task that does a single monolithic
	// activity, this will be fixed and unchanging.
	// For tasks that have various substeps, this field will change
	// as the task progresses from one phase to another.
	Description *types.LocalizableMessage `xml:"description,omitempty" json:"description,omitempty"`
	// The name of the operation that created the task.
	//
	// This is not set
	// for internal tasks.
	Name string `xml:"name,omitempty" json:"name,omitempty"`
	// An identifier for this operation.
	//
	// This includes publicly visible
	// internal tasks and is a lookup in the TaskDescription methodInfo
	// data object.
	DescriptionId string `xml:"descriptionId" json:"descriptionId"`
	// Managed entity to which the operation applies.
	//
	// Refers instance of `ManagedEntity`.
	Entity *types.ManagedObjectReference `xml:"entity,omitempty" json:"entity,omitempty"`
	// The name of the managed entity, locale-specific, retained for the
	// history collector database.
	EntityName string `xml:"entityName,omitempty" json:"entityName,omitempty"`
	// If the state of the task is "running", then this property is a list of
	// managed entities that the operation has locked, with a shared lock.
	//
	// Refers instances of `ManagedEntity`.
	Locked []types.ManagedObjectReference `xml:"locked,omitempty" json:"locked,omitempty"`
	// Runtime status of the task.
	State VslmTaskInfoState `xml:"state" json:"state"`
	// Flag to indicate whether or not the client requested
	// cancellation of the task.
	Cancelled bool `xml:"cancelled" json:"cancelled"`
	// Flag to indicate whether or not the cancel task operation is supported.
	Cancelable bool `xml:"cancelable" json:"cancelable"`
	// If the task state is "error", then this property contains the fault code.
	Error *types.LocalizedMethodFault `xml:"error,omitempty" json:"error,omitempty"`
	// If the task state is "success", then this property may be used
	// to hold a return value.
	Result types.AnyType `xml:"result,omitempty,typeattr" json:"result,omitempty"`
	// If the task state is "running", then this property contains a
	// progress measurement, expressed as percentage completed, from 0 to 100.
	//
	// If this property is not set, then the command does not report progress.
	Progress int32 `xml:"progress,omitempty" json:"progress,omitempty"`
	// Kind of entity responsible for creating this task.
	Reason BaseVslmTaskReason `xml:"reason,typeattr" json:"reason"`
	// Time stamp when the task was created.
	QueueTime time.Time `xml:"queueTime" json:"queueTime"`
	// Time stamp when the task started running.
	StartTime *time.Time `xml:"startTime" json:"startTime,omitempty"`
	// Time stamp when the task was completed (whether success or failure).
	CompleteTime *time.Time `xml:"completeTime" json:"completeTime,omitempty"`
	// Event chain ID that leads to the corresponding events.
	EventChainId int32 `xml:"eventChainId" json:"eventChainId"`
	// The user entered tag to identify the operations and their side effects
	ChangeTag string `xml:"changeTag,omitempty" json:"changeTag,omitempty"`
	// Tasks can be created by another task.
	//
	// This shows `VslmTaskInfo.key` of the task spun off this task. This is to
	// track causality between tasks.
	ParentTaskKey string `xml:"parentTaskKey,omitempty" json:"parentTaskKey,omitempty"`
	// Tasks can be created by another task and such creation can go on for
	// multiple levels.
	//
	// This is the `VslmTaskInfo.key` of the task
	// that started the chain of tasks.
	RootTaskKey string `xml:"rootTaskKey,omitempty" json:"rootTaskKey,omitempty"`
	// The activation Id is a client-provided token to link an API call with a task.
	ActivationId string `xml:"activationId,omitempty" json:"activationId,omitempty"`
}

This data object type contains all information about a VSLM task.

A task represents an operation performed by VirtualCenter or ESX.

This structure may be used only with operations rendered under `/vslm`.

type VslmTaskInfoState

type VslmTaskInfoState string

List of possible states of a task.

func (VslmTaskInfoState) Strings added in v0.38.0

func (e VslmTaskInfoState) Strings() []string

func (VslmTaskInfoState) Values added in v0.38.0

func (e VslmTaskInfoState) Values() []VslmTaskInfoState

type VslmTaskReason

type VslmTaskReason struct {
	types.DynamicData
}

Base type for all task reasons.

Task reasons represent the kind of entity responsible for a task's creation.

This structure may be used only with operations rendered under `/vslm`.

func (*VslmTaskReason) GetVslmTaskReason

func (b *VslmTaskReason) GetVslmTaskReason() *VslmTaskReason

type VslmTaskReasonAlarm

type VslmTaskReasonAlarm struct {
	VslmTaskReason

	// The name of the alarm that queued the task, retained in the history
	// collector database.
	AlarmName string `xml:"alarmName" json:"alarmName"`
	// The alarm object that queued the task.
	//
	// Refers instance of `Alarm`.
	Alarm types.ManagedObjectReference `xml:"alarm" json:"alarm"`
	// The name of the managed entity on which the alarm is triggered,
	// retained in the history collector database.
	EntityName string `xml:"entityName" json:"entityName"`
	// The managed entity object on which the alarm is triggered.
	//
	// Refers instance of `ManagedEntity`.
	Entity types.ManagedObjectReference `xml:"entity" json:"entity"`
}

Indicates that the task was queued by an alarm.

This structure may be used only with operations rendered under `/vslm`.

type VslmTaskReasonSchedule

type VslmTaskReasonSchedule struct {
	VslmTaskReason

	// The name of the scheduled task that queued this task.
	Name string `xml:"name" json:"name"`
	// The scheduledTask object that queued this task.
	//
	// Refers instance of `ScheduledTask`.
	ScheduledTask types.ManagedObjectReference `xml:"scheduledTask" json:"scheduledTask"`
}

Indicates that the task was queued by a scheduled task.

This structure may be used only with operations rendered under `/vslm`.

type VslmTaskReasonSystem

type VslmTaskReasonSystem struct {
	VslmTaskReason
}

Indicates that the task was started by the system (a default task).

This structure may be used only with operations rendered under `/vslm`.

type VslmTaskReasonUser

type VslmTaskReasonUser struct {
	VslmTaskReason

	// Name of the user that queued the task.
	UserName string `xml:"userName" json:"userName"`
}

Indicates that the task was queued by a specific user.

This structure may be used only with operations rendered under `/vslm`.

type VslmUpdateVStorageInfrastructureObjectPolicyRequestType

type VslmUpdateVStorageInfrastructureObjectPolicyRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// specification to assign a SPBM policy to FCD infrastructure
	// object.
	Spec types.VslmInfrastructureObjectPolicySpec `xml:"spec" json:"spec"`
}

The parameters of `VslmVStorageObjectManager.VslmUpdateVStorageInfrastructureObjectPolicy_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmUpdateVStorageInfrastructureObjectPolicy_TaskResponse

type VslmUpdateVStorageInfrastructureObjectPolicy_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmUpdateVStorageObjectMetadataRequestType

type VslmUpdateVStorageObjectMetadataRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// array of key/value strings. (keys must be unique
	// within the list)
	Metadata []types.KeyValue `xml:"metadata,omitempty" json:"metadata,omitempty"`
	// array of keys need to be deleted
	DeleteKeys []string `xml:"deleteKeys,omitempty" json:"deleteKeys,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmUpdateVStorageObjectMetadata_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmUpdateVStorageObjectMetadata_TaskResponse

type VslmUpdateVStorageObjectMetadata_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmUpdateVstorageObjectCryptoRequestType added in v0.23.0

type VslmUpdateVstorageObjectCryptoRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// New profile requirement on the virtual storage object.
	Profile []types.VirtualMachineProfileSpec `xml:"profile,omitempty" json:"profile,omitempty"`
	// The crypto information of each disk on the chain.
	DisksCrypto *types.DiskCryptoSpec `xml:"disksCrypto,omitempty" json:"disksCrypto,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmUpdateVstorageObjectCrypto_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmUpdateVstorageObjectCrypto_Task added in v0.23.0

type VslmUpdateVstorageObjectCrypto_Task VslmUpdateVstorageObjectCryptoRequestType

type VslmUpdateVstorageObjectCrypto_TaskResponse added in v0.23.0

type VslmUpdateVstorageObjectCrypto_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmUpdateVstorageObjectPolicyRequestType

type VslmUpdateVstorageObjectPolicyRequestType struct {
	This types.ManagedObjectReference `xml:"_this" json:"_this"`
	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// New profile requirement on the virtual storage object.
	Profile []types.VirtualMachineProfileSpec `xml:"profile,omitempty" json:"profile,omitempty"`
}

The parameters of `VslmVStorageObjectManager.VslmUpdateVstorageObjectPolicy_Task`.

This structure may be used only with operations rendered under `/vslm`.

type VslmUpdateVstorageObjectPolicy_TaskResponse

type VslmUpdateVstorageObjectPolicy_TaskResponse struct {
	Returnval types.ManagedObjectReference `xml:"returnval" json:"returnval"`
}

type VslmVsoVStorageObjectAssociations

type VslmVsoVStorageObjectAssociations struct {
	types.DynamicData

	// ID of this virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// Array of vm associations related to the virtual storage object.
	VmDiskAssociation []VslmVsoVStorageObjectAssociationsVmDiskAssociation `xml:"vmDiskAssociation,omitempty" json:"vmDiskAssociation,omitempty"`
	// Received error while generating associations.
	Fault *types.LocalizedMethodFault `xml:"fault,omitempty" json:"fault,omitempty"`
}

This data object is a key-value pair whose key is the virtual storage object id, and value is the vm association information.

This structure may be used only with operations rendered under `/vslm`.

type VslmVsoVStorageObjectAssociationsVmDiskAssociation

type VslmVsoVStorageObjectAssociationsVmDiskAssociation struct {
	types.DynamicData

	// ID of the virtual machine.
	VmId string `xml:"vmId" json:"vmId"`
	// Device key of the disk attached to the VM.
	DiskKey int32 `xml:"diskKey" json:"diskKey"`
}

This data object contains infomation of a VM Disk association.

This structure may be used only with operations rendered under `/vslm`.

type VslmVsoVStorageObjectQueryResult

type VslmVsoVStorageObjectQueryResult struct {
	types.DynamicData

	// If set to false, more results were found than could be returned (either
	// limited by maxResult input argument in the
	// `VslmVStorageObjectManager.VslmListVStorageObjectForSpec` API or
	// truncated because the number of results exceeded the internal limit).
	AllRecordsReturned bool `xml:"allRecordsReturned" json:"allRecordsReturned"`
	// IDs of the VStorageObjects matching the query criteria
	// NOTE: This field will be removed once the dev/qe code is refactored.
	//
	// IDs will be returned in ascending order. If
	// `VslmVsoVStorageObjectQueryResult.allRecordsReturned` is set to false,
	// to get the additional results, repeat the query with ID > last ID as
	// part of the query spec `VslmVsoVStorageObjectQuerySpec`.
	Id []types.ID `xml:"id,omitempty" json:"id,omitempty"`
	// Results of the query criteria.
	//
	// `IDs` will be returned in
	// ascending order. If `VslmVsoVStorageObjectQueryResult.allRecordsReturned`
	// is set to false,then, to get the additional results, repeat the query
	// with ID > last ID as part of the query spec
	// `VslmVsoVStorageObjectQuerySpec`.
	QueryResults []VslmVsoVStorageObjectResult `xml:"queryResults,omitempty" json:"queryResults,omitempty"`
}

The `VslmVsoVStorageObjectQueryResult` contains the result of `VslmVStorageObjectManager.VslmListVStorageObjectForSpec` API.

This structure may be used only with operations rendered under `/vslm`.

type VslmVsoVStorageObjectQuerySpec

type VslmVsoVStorageObjectQuerySpec struct {
	types.DynamicData

	// This field specifies the searchable field.
	//
	// This can be one of the values from
	// `VslmVsoVStorageObjectQuerySpecQueryFieldEnum_enum`.
	QueryField string `xml:"queryField" json:"queryField"`
	// This field specifies the operator to compare the searchable field
	// `VslmVsoVStorageObjectQuerySpec.queryField` with the specified
	// value `VslmVsoVStorageObjectQuerySpec.queryValue`.
	//
	// This can be one of the values from `VslmVsoVStorageObjectQuerySpecQueryOperatorEnum_enum`.
	QueryOperator string `xml:"queryOperator" json:"queryOperator"`
	// This field specifies the value to be compared with the searchable field.
	QueryValue []string `xml:"queryValue,omitempty" json:"queryValue,omitempty"`
}

The `VslmVsoVStorageObjectQuerySpec` describes the criteria to query VStorageObject from global catalog.

`VslmVsoVStorageObjectQuerySpec` is sent as input to `VslmVStorageObjectManager.VslmListVStorageObjectForSpec` API.

This structure may be used only with operations rendered under `/vslm`.

type VslmVsoVStorageObjectQuerySpecQueryFieldEnum

type VslmVsoVStorageObjectQuerySpecQueryFieldEnum string

The `VslmVsoVStorageObjectQuerySpecQueryFieldEnum_enum` enumerated type defines the searchable fields.

func (VslmVsoVStorageObjectQuerySpecQueryFieldEnum) Strings added in v0.38.0

func (VslmVsoVStorageObjectQuerySpecQueryFieldEnum) Values added in v0.38.0

type VslmVsoVStorageObjectQuerySpecQueryOperatorEnum

type VslmVsoVStorageObjectQuerySpecQueryOperatorEnum string

The `VslmVsoVStorageObjectQuerySpecQueryOperatorEnum_enum` enumerated type defines the operators to use for constructing the query criteria.

func (VslmVsoVStorageObjectQuerySpecQueryOperatorEnum) Strings added in v0.38.0

func (VslmVsoVStorageObjectQuerySpecQueryOperatorEnum) Values added in v0.38.0

type VslmVsoVStorageObjectResult

type VslmVsoVStorageObjectResult struct {
	types.DynamicData

	// The ID of the virtual storage object.
	Id types.ID `xml:"id" json:"id"`
	// Name of FCD.
	Name string `xml:"name,omitempty" json:"name,omitempty"`
	// The size in MB of this object.
	//
	// If the faults are set,
	// then the capacityInMB will be -1
	CapacityInMB int64 `xml:"capacityInMB" json:"capacityInMB"`
	// The create time information of the FCD.
	CreateTime *time.Time `xml:"createTime" json:"createTime,omitempty"`
	// The Datastore URL containing the FCD.
	DatastoreUrl string `xml:"datastoreUrl,omitempty" json:"datastoreUrl,omitempty"`
	// The disk path of the FCD.
	DiskPath string `xml:"diskPath,omitempty" json:"diskPath,omitempty"`
	// The rolled up used capacity of the FCD and it's snapshots.
	//
	// Returns -1L if the space information is currently unavailable.
	UsedCapacityInMB int64 `xml:"usedCapacityInMB,omitempty" json:"usedCapacityInMB,omitempty"`
	// The ID of the backing object of the virtual storage object.
	BackingObjectId *types.ID `xml:"backingObjectId,omitempty" json:"backingObjectId,omitempty"`
	// VStorageObjectSnapshotResult array containing information about all the
	// snapshots of the virtual storage object.
	SnapshotInfo []VslmVsoVStorageObjectSnapshotResult `xml:"snapshotInfo,omitempty" json:"snapshotInfo,omitempty"`
	// Metadata array of key/value strings.
	Metadata []types.KeyValue `xml:"metadata,omitempty" json:"metadata,omitempty"`
	// The fault is set in case of error conditions and this property will
	// have the reason.
	//
	// Possible Faults:
	// NotFound If specified virtual storage object cannot be found.
	Error *types.LocalizedMethodFault `xml:"error,omitempty" json:"error,omitempty"`
}

The `VslmVsoVStorageObjectResult` contains the result objects of `VslmVsoVStorageObjectQueryResult` which is returned as a result of `VslmVStorageObjectManager.VslmListVStorageObjectForSpec` and `VslmVStorageObjectManager.VslmRetrieveVStorageObjects` APIs.

This structure may be used only with operations rendered under `/vslm`.

type VslmVsoVStorageObjectSnapshotResult added in v0.22.0

type VslmVsoVStorageObjectSnapshotResult struct {
	types.DynamicData

	// The ID of the vsan object backing a snapshot of the virtual storage
	// object.
	BackingObjectId types.ID `xml:"backingObjectId" json:"backingObjectId"`
	// The description user passed in when creating this snapshot.
	Description string `xml:"description,omitempty" json:"description,omitempty"`
	// The ID of this snapshot, created and used in fcd layer.
	SnapshotId *types.ID `xml:"snapshotId,omitempty" json:"snapshotId,omitempty"`
	// The file path of this snapshot.
	DiskPath string `xml:"diskPath,omitempty" json:"diskPath,omitempty"`
}

The `VslmVsoVStorageObjectSnapshotResult` contains brief information about a snapshot of the object `VslmVsoVStorageObjectResult` which is returned as a result of `VslmVStorageObjectManager.VslmRetrieveVStorageObjects` API.

This structure may be used only with operations rendered under `/vslm`.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL