Scripting Object - VcSdkConnection

Scripting-object corresponding to
SdkConnection
Attribute of
_VcPlugin, VcAlarm, VcAlarmManager, VcAuthorizationManager, VcClusterComputeResource, VcClusterProfile, VcClusterProfileManager, VcComputeResource, VcCustomFieldsManager, VcCustomizationSpecManager, VcDatacenter, VcDatastore, VcDatastoreNamespaceManager, VcDiagnosticManager, VcDistributedVirtualPortgroup, VcDistributedVirtualSwitch, VcDistributedVirtualSwitchManager, VcEnvironmentBrowser, VcEventHistoryCollector, VcEventManager, VcExtensionManager, VcFileManager, VcFolder, VcGuestAuthManager, VcGuestFileManager, VcGuestOperationsManager, VcGuestProcessManager, VcHistoryCollector, VcHostActiveDirectoryAuthentication, VcHostAuthenticationManager, VcHostAuthenticationStore, VcHostAutoStartManager, VcHostBootDeviceSystem, VcHostCacheConfigurationManager, VcHostCpuSchedulerSystem, VcHostDatastoreBrowser, VcHostDatastoreSystem, VcHostDateTimeSystem, VcHostDiagnosticSystem, VcHostDirectoryStore, VcHostEsxAgentHostManager, VcHostFirewallSystem, VcHostFirmwareSystem, VcHostGraphicsManager, VcHostHealthStatusSystem, VcHostImageConfigManager, VcHostKernelModuleSystem, VcHostLocalAccountManager, VcHostLocalAuthentication, VcHostMemorySystem, VcHostNetworkSystem, VcHostPatchManager, VcHostPciPassthruSystem, VcHostPowerSystem, VcHostProfile, VcHostProfileManager, VcHostServiceSystem, VcHostSnmpSystem, VcHostStorageSystem, VcHostSystem, VcHostVFlashManager, VcHostVirtualNicManager, VcHostVMotionSystem, VcHostVsanInternalSystem, VcHostVsanSystem, VcHttpNfcLease, VcIpPoolManager, VcIscsiManager, VcLicenseAssignmentManager, VcLicenseManager, VcLocalizationManager, VcNetwork, VcOpaqueNetwork, VcOptionManager, VcOvfManager, VcPerformanceManager, VcProfile, VcProfileComplianceManager, VcProfileManager, VcPropertyCollector, VcPropertyFilter, VcResourcePlanningManager, VcResourcePool, VcScheduledTask, VcScheduledTaskManager, VcSearchIndex, VcServiceManager, VcSessionManager, VcSimpleCommand, VcStoragePod, VcStorageResourceManager, VcTask, VcTaskHistoryCollector, VcTaskManager, VcUserDirectory, VcViewManager, VcVirtualApp, VcVirtualDiskManager, VcVirtualizationManager, VcVirtualMachine, VcVirtualMachineCompatibilityChecker, VcVirtualMachineProvisioningChecker, VcVirtualMachineSnapshot, VcVmwareDistributedVirtualSwitch

Scripting Object Description

This object represents a connection to a vCenter host. VcHostSystem represents an ESX host.

Attributes

Name Type Description
aboutVcAboutInfo

Information about the service, such as the software version.
aboutInfoVcAboutInfoDeprecated.

Information about the service, such as the software version.
As of vSphere API 4.0, use about
accountManagerVcHostLocalAccountManager

A singleton managed object that manages host local user and group accounts.
alarmManagerVcAlarmManager

A singleton managed object that manages alarms.
allClusterComputeResourcesVcClusterComputeResource [] Deprecated.

Returns all ClusterComputeResources.
As of vSphere API 4.0, use getAllClusterComputeResources(additionalPropertyFilters)
allComputeResourcesVcComputeResource [] Deprecated.

Returns all ComputeResources.
As of vSphere API 4.0, use getAllComputeResources(additionalPropertyFilters)
allDatacenterFoldersVcFolder [] Deprecated.

Returns all DatacenterFolders.
As of vSphere API 4.0, use getAllDatacenterFolders(additionalPropertyFilters)
allDatacentersVcDatacenter [] Deprecated.

Returns all Datacenters.
As of vSphere API 4.0, use getAllDatacenters(additionalPropertyFilters)
allDatastoreFoldersVcFolder [] Deprecated.

Returns all DatastoreFolders.
As of vSphere API 4.0, use getAllDatastoreFolders(additionalPropertyFilters)
allDatastoresVcDatastore [] Deprecated.

Returns all Datastores.
As of vSphere API 4.0, use getAllDatastores(additionalPropertyFilters)
allDistributedVirtualPortgroupsVcDistributedVirtualPortgroup [] Deprecated.

Returns all DistributedVirtualPortgroups.
As of vSphere API 4.0, use getAllDistributedVirtualPortgroups(additionalPropertyFilters)
allHostfoldersVcFolder [] Deprecated.

Returns all HostFolders.
As of vSphere API 4.0, use getAllHosts(additionalPropertyFilters)
allHostSystemsVcHostSystem [] Deprecated.

Returns all DatacenterFolders.
As of vSphere API 4.0, use getAllHostSystems(additionalPropertyFilters)
allNetworkFoldersVcFolder [] Deprecated.

Returns all NetworkFolders.
As of vSphere API 4.0, use getAllNetworkFolders(additionalPropertyFilters)
allNetworksVcNetwork [] Deprecated.

Returns all Networks.
As of vSphere API 4.0, use getAllNetworks(additionalPropertyFilters)
allResourcePoolsVcResourcePool [] Deprecated.

Returns all ResourcePools.
As of vSphere API 4.0, use getAllResourcePools(additionalPropertyFilters)
allTasksVcTask [] Deprecated.

Returns all Tasks.
As of vSphere API 4.0, use getAllTasks(additionalPropertyFilters)
allVirtualAppsVcVirtualApp [] Deprecated.

Returns all VirtualApps.
As of vSphere API 4.0, use getAllVirtualApps(additionalPropertyFilters)
allVirtualMachinesVcVirtualMachine [] Deprecated.

Returns all VirtualMachines.
As of vSphere API 4.0, use getAllVirtualMachines(additionalPropertyFilters)
allVirtualMachineSnapshotsVcVirtualMachineSnapshot [] Deprecated.

Returns all VirtualMachineSnapshots.
As of vSphere API 4.0, use getAllVirtualMachineSnapshots(additionalPropertyFilters)
allVmFoldersVcFolder [] Deprecated.

Returns all VmFolders.
As of vSphere API 4.0, use getAllVmFolders(additionalPropertyFilters)
authorizationManagerVcAuthorizationManager

Manages permissions for managed entities in the service.
clusterProfileManagerVcClusterProfileManager

A singleton managed object that manages the cluster profiles.
complianceManagerVcProfileComplianceManager

A singleton managed object that manages compliance aspects of entities.
customFieldsManagerVcCustomFieldsManager

A singleton managed object that managed custom fields.
customizationSpecManagerVcCustomizationSpecManager

A singleton managed object that manages saved guest customization specifications.
diagnosticManagerVcDiagnosticManager

A singleton managed object that provides access to low-level log files.
dvSwitchManagerVcDistributedVirtualSwitchManager

A singleton managed object that provides relevant information of DistributedVirtualSwitch.
eventManagerVcEventManager

A singleton managed object that manages events.
extensionManagerVcExtensionManager

A singleton managed object that manages extensions.
fileManagerVcFileManager

A singleton managed object that allows management of files present on datastores.
guestOperationsManagerVcGuestOperationsManager

A singleton managed object that provides methods for guest operations.
hostLocalAccountManagerVcHostLocalAccountManagerDeprecated.

A singleton managed object that manages host local user and group accounts.
As of vSphere API 4.0, use accountManager
hostProfileManagerVcHostProfileManager

A singleton managed object that manages the host profiles.
ipPoolManagerVcIpPoolManager

A singleton managed object that supports management of IpPool objects. IP pools are used when allocating IPv4 and IPv6 addresses to vApps.
licenseManagerVcLicenseManager

A singleton managed object that manages licensing
localizationManagerVcLocalizationManager

A singleton managed object that provides methods for retrieving message catalogs for client-side localization support.
optionManagerVcOptionManagerDeprecated.

Generic configuration for a management server. This is for example by VirtualCenter to store the VirtualCenter Settings. This is not used for a stand-alone host, instead the vim.host.ConfigManager.advancedOption is used.
As of vSphere API 4.0, use setting
ovfManagerVcOvfManager

A singleton managed object that can generate OVF descriptors (export) and create VMs and VServices based on OVF descriptors (import).
perfManagerVcPerformanceManager

A singleton managed object that manages the collection and reporting of performance statistics.
performanceManagerVcPerformanceManagerDeprecated.

A singleton managed object that manages the collection and reporting of performance statistics.
As of vSphere API 4.0, use perfManager
propertyCollectorVcPropertyCollector

Reference to a per-session object for retrieving properties and updates.
rootFolderVcFolder

Reference to the top of the inventory managed by this service.
scheduledTaskManagerVcScheduledTaskManager

A singleton managed object that manages scheduled tasks.
searchIndexVcSearchIndex

A singleton managed object that allows search of the inventory.
serviceInstanceVcServiceInstance

The ServiceInstance managed object is the singleton root object of the inventory on both vCenter servers and servers running on standalone host agents.
sessionManagerVcSessionManager

Managed object for logging in and managing sessions.
settingVcOptionManager

Generic configuration for a management server. This is for example by VirtualCenter to store the VirtualCenter Settings. This is not used for a stand-alone host, instead the vim.host.ConfigManager.advancedOption is used.
snmpSystemVcHostSnmpSystem

A singleton managed object that allows SNMP configuration. Not set if not supported on a particular platform.
storageResourceManagerVcStorageResourceManager

A singleton managed object that provides methods for storage resource management.
taskManagerVcTaskManager

A singleton managed object that manages tasks.
userDirectoryVcUserDirectory

A user directory managed object.
viewManagerVcViewManager

A singleton managed object for tracking custom sets of objects.
virtualDiskManagerVcVirtualDiskManager

A singleton managed object that allows management of virtual disks on datastores.
virtualizationMangerVcVirtualizationManager

A singleton managed object that manages the discovery, analysis, recommendation and virtualization of physical machines.
vmCompatibilityCheckerVcVirtualMachineCompatibilityChecker

A singleton managed object that can answer questions about compatibility of a virtual machine with a host.
vmProvisioningCheckerVcVirtualMachineProvisioningChecker

A singleton managed object that can answer questions about the feasibility of certain provisioning operations.

Methods

Methods defined in this Scripting Object
executeQuery, getAllClusterComputeResources, getAllComputeResources, getAllDatacenterFolders, getAllDatacenters, getAllDatastoreFolders, getAllDatastores, getAllDistributedVirtualPortgroups, getAllHostFolders, getAllHostSystems, getAllManagedObjects, getAllNetworkFolders, getAllNetworks, getAllResourcePools, getAllTasks, getAllVirtualApps, getAllVirtualMachines, getAllVirtualMachineSnapshots, getAllVmFolders, isInventoryServiceAvailable

getAllManagedObjects

Returns all ManagedObjects

Parameters

NameTypeDescription
sdkTypeString

VI type
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcManagedObject []

getAllDatacenterFolders

Returns all DatacenterFolders

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcFolder []

getAllDatacenters

Returns all Datacenters

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcDatacenter []

getAllHostFolders

Returns all HostFolders

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcFolder []

getAllHostSystems

Returns all HostSystems

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcHostSystem []

getAllComputeResources

Returns all ComputeResources

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcComputeResource []

getAllClusterComputeResources

Returns all ClusterComputeResources

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcClusterComputeResource []

getAllResourcePools

Returns all ResourcePools

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcResourcePool []

getAllVirtualApps

Returns all VirtualApps

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcVirtualApp []

getAllDatastoreFolders

Returns all HostSystems

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcFolder []

getAllDatastores

Returns all Datastores

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcDatastore []

getAllNetworkFolders

Returns all NetworkFolders

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcFolder []

getAllNetworks

Returns all Networks

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcNetwork []

getAllDistributedVirtualPortgroups

Returns all DistributedVirtualPortgroups

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcDistributedVirtualPortgroup []

getAllVmFolders

Returns all VmFolders

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcFolder []

getAllVirtualMachines

Returns all VirtualMachines

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcVirtualMachine []

getAllVirtualMachineSnapshots

Returns all VirtualMachineSnapshots

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcVirtualMachineSnapshot []

getAllTasks

Returns all Tasks

Parameters

NameTypeDescription
additionalPropertyFiltersString []

Top level property filters
queryString

XPath query

Return Value

Type Description
VcTask []

executeQuery

Execute XQuery against VSphere query service if available. If query service is not supported returns empty string

Parameters

NameTypeDescription
xQueryString

XQuery to execute

Return Value

Type Description
String

isInventoryServiceAvailable

Checks the availability of the vCenter Inventory Service.

Parameters

NameTypeDescription
None

Return Value

Type Description
String