Managed Object - ManagedEntity

Property of: AlarmInfo, AlarmState, ComplianceResult, ConflictingConfigurationConfig, ContainerView, DatacenterMismatchArgument, DistributedVirtualSwitchManagerHostContainer, DistributedVirtualSwitchPortConnectee, DistributedVirtualSwitchPortCriteria, DVPortConfigInfo, DVPortConfigSpec, DVPortgroupConfigInfo, DVPortgroupConfigSpec, DvsScopeViolated, EntityBackupConfig, EntityPrivilege, EventFilterSpecByEntity, ExtExtendedProductInfo, Folder, HealthUpdate, HttpNfcLeaseInfo, InvalidFolder, InvalidName, KmipClusterInfo, ManagedEntity, ManagedEntityEventArgument, OvfConsumerOstNode, Permission, Profile, ReplicationInvalidOptions, ResourceConfigSpec, ScheduledTaskInfo, StructuredCustomizations, TaskFilterSpecByEntity, TaskInfo, TaskReasonAlarm, UserPrivilegeResult, VAppCloneSpecResourceMap, VAppEntityConfigInfo, VirtualApp, VirtualAppLinkInfo, VirtualMachine, VmFaultToleranceConfigIssue, VmFaultToleranceConfigIssueWrapper
Parameter to: AcknowledgeAlarm, AddFilterEntities, AddMonitoredEntities, AreAlarmActionsEnabled, AssociateProfile, CheckCompliance_Task, CheckProfileCompliance_Task, ClearComplianceStatus, CloseInventoryViewFolder, CreateAlarm, CreateContainerView, CreateDescriptor, CreateScheduledTask, DisableAlarm, DissociateProfile, EnableAlarm, EnableAlarmActions, FetchUserPrivilegeOnEntities, FindAssociatedProfile, FindChild, GetAlarm, GetAlarmState, GetDefaultKmsCluster, HasMonitoredEntity, HasPrivilegeOnEntities, HasPrivilegeOnEntity, LogUserEvent, MarkServiceProviderEntities, MoveIntoFolder_Task, MoveIntoResourcePool, OpenInventoryViewFolder, QueryCompatibleHostForExistingDvs, QueryCompatibleHostForNewDvs, QueryComplianceStatus, RemoveEntityPermission, RemoveFilterEntities, RemoveMonitoredEntities, ResetEntityPermissions, RetrieveEntityPermissions, RetrieveEntityScheduledTask, SetDefaultKmsCluster, SetEntityPermissions, SetField, UnmarkServiceProviderEntities, UpdateLinkedChildren
Returned by: CloseInventoryViewFolder, FindAllByDnsName, FindAllByIp, FindAllByUuid, FindByDnsName, FindByInventoryPath, FindByIp, FindByUuid, FindChild, OpenInventoryViewFolder, QueryFilterEntities, QueryManagedBy, QueryMonitoredEntities, RetrieveServiceProviderEntities
Extended by: ComputeResource, Datacenter, Datastore, DistributedVirtualSwitch, Folder, HostSystem, Network, ResourcePool, VirtualMachine
Extends: ExtensibleManagedObject
See also: AlarmState, CustomFieldValue, Event, ManagedEntityStatus, Permission, Tag, Task
Since: null

Managed Object Description

Properties

Name	Type	Description
alarmActionsEnabled* P	xsd:boolean	*Since* vSphere API 4.0
configIssue*	Event[]
configStatus	ManagedEntityStatus
customValue* P	CustomFieldValue[]
declaredAlarmState* P	AlarmState[]
disabledMethod*	xsd:string[]
effectiveRole* P	xsd:int[]
name P	xsd:string
overallStatus	ManagedEntityStatus
parent* P	ManagedObjectReference to a ManagedEntity
permission*	Permission[]
recentTask*	ManagedObjectReference[] to a Task[]
tag* P	Tag[]	*Since* vSphere API 4.0
triggeredAlarmState* P	AlarmState[]
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be presentPRequired privilege - see tooltip for details

Methods

Methods defined in this Managed Object
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

Destroy_Task

Required Privileges: When object is ComputeResource - Host.Inventory.RemoveHostFromCluster
When object is VirtualMachine - VirtualMachine.Inventory.Delete
When object is VmwareDistributedVirtualSwitch - DVSwitch.Delete
When object is Network - System.Read
When object is Datacenter - Datacenter.Delete
When object is HostSystem - Host.Inventory.RemoveHostFromCluster
When object is ClusterComputeResource - Host.Inventory.DeleteCluster
When object is ResourcePool - Resource.DeletePool
When object is Folder - Folder.Delete
When object is VirtualApp - VApp.Delete
When object is StoragePod - Folder.Delete
When object is Datastore - System.Read
When object is DistributedVirtualSwitch - DVSwitch.Delete
When object is DistributedVirtualPortgroup - DVPortgroup.Delete

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ManagedEntity used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VimFault

Events

Type
None

Reload

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ManagedEntity used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Rename_Task

Required Privileges: When object is VirtualApp - VApp.Rename
When object is Datastore - Datastore.Rename
When object is VirtualMachine - VirtualMachine.Config.Rename
When object is VmwareDistributedVirtualSwitch - DVSwitch.Modify
When object is Network - System.Read
When object is Datacenter - Datacenter.Rename
When object is ClusterComputeResource - Host.Inventory.RenameCluster
When object is DistributedVirtualSwitch - DVSwitch.Modify
When object is ResourcePool - Resource.RenamePool
When object is DistributedVirtualPortgroup - DVPortgroup.Modify
When object is Folder - Folder.Rename

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ManagedEntity used to make the method call.

newName P

xsd:string

Since null

P Required privilege: newName

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
DuplicateName
InvalidName
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None