Scripting Object - _VcPlugin

Singleton
VcPlugin

Scripting Object Description

This object serves as an aggregator for every vCenter connection defined for the plugin. It acts as an entry point from where objects belonging to multiple vCenters can be accessed.

Attributes

Name Type Description
allClusterComputeResourcesObject [] Deprecated.

@since Unknown
allComputeResourcesObject [] Deprecated.

@since Unknown
allDatacenterFoldersObject [] Deprecated.

@since Unknown
allDatacentersObject [] Deprecated.

@since Unknown
allDatastoreFoldersObject [] Deprecated.

@since Unknown
allDatastoresObject []

@since Unknown
allDistributedVirtualPortgroupsObject [] Deprecated.

@since Unknown
allHostFoldersObject [] Deprecated.

@since Unknown
allHostSystemsObject [] Deprecated.

@since Unknown
allNetworkFoldersObject []

@since Unknown
allNetworksObject [] Deprecated.

@since Unknown
allRegisteredInstancesObject []

Returns URLs of all registered vCenter server instances @since Unknown
allResourcePoolsObject []

@since Unknown
allSdkConnectionsObject []

@since Unknown
allTasksObject [] Deprecated.

@since Unknown
allVimHostsObject [] Deprecated.

Returns all SDK Connections.
As of vSphere API 4.0, use allSdkConnections @since Unknown
allVirtualAppsObject [] Deprecated.

@since Unknown
allVirtualMachinesObject [] Deprecated.

@since Unknown
allVirtualMachineSnapshotsObject [] Deprecated.

@since Unknown
allVmFoldersObject [] Deprecated.

@since Unknown
extensionKeyString

Returns the extension key of this vCenter Orchestrator instance. @since Unknown
vimHostsObject [] Deprecated.

@since Unknown

Methods

Methods defined in this Scripting Object
convertToVimManagedObject, createCustomizationPasswordFromCredentials, currentTime, deepClone, findSdkConnectionForUUID, getAllClusterComputeResources, getAllComputeResources, getAllDatacenterFolders, getAllDatacenters, getAllDatastoreFolders, getAllDatastores, getAllDistributedVirtualPortgroups, getAllHostFolders, getAllHostSystems, getAllNetworkFolders, getAllNetworks, getAllResourcePools, getAllTasks, getAllVimManagedObjects, getAllVirtualApps, getAllVirtualMachines, getAllVirtualMachineSnapshots, getAllVmFolders, getManagedObjectsForIds, getManagedObjectsForTypesAndIds, getManagedObjectsForURIs, getProvisionedSpace, getRegisteredInstanceProperties, importOvf, refreshObjects, registerExtension, registerVCenterServerInstance, toManagedObject, toManagedObjectRef, unregisterExtension, unregisterVCenterServerInstance, updateVCenterServerInstance, validateConnection, validatePbmServiceAvailability, validateSmsServiceAvailability

getAllResourcePools

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcResourcePool []

getAllHostFolders

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcHostFolder []

getRegisteredInstanceProperties

Returns properties of selected vCenter server instance @since Unknown

Parameters

NameTypeDescription
hostUrlString


Return Value

Type Description
Properties

getManagedObjectsForIds

Returns ManagedObjects of same type from their IDs. @since Unknown

Parameters

NameTypeDescription
sdkTypeString

idsString []


Return Value

Type Description
VcManagedObject []

getAllVimManagedObjects

@since Unknown

Parameters

NameTypeDescription
sdkTypeString

additionalFiltersString []

queryString


Return Value

Type Description
VcManagedObject []

importOvf

Import ovf file from file://, http:// or https:// location @since Unknown

Parameters

NameTypeDescription
ovfUriString

hostSystemVcHostSystem

importFolderVcFolder

vmNameString

networksVcOvfNetworkMapping []

datastoreVcDatastore

propsVcKeyValue []


Return Value

Type Description
VcVirtualMachine

toManagedObject

Convert one or many ManagedObjectReference(s) to ManagedObject instance(s). @since Unknown

Parameters

NameTypeDescription
factoryHolderAny

objectAny


Return Value

Type Description
Any

getManagedObjectsForURIs

Returns ManagedObjects from their URIs @since Unknown

Parameters

NameTypeDescription
uriStringsString []


Return Value

Type Description
VcManagedObject []

createCustomizationPasswordFromCredentials

Creates VcCustomizationPassword from provided Credential. @since Unknown

Parameters

NameTypeDescription
credentialsCredential

plainTextBoolean


Return Value

Type Description
VcCustomizationPassword

validateSmsServiceAvailability

@since Unknown

Parameters

NameTypeDescription
smsServiceUrlString


Return Value

Type Description
None

convertToVimManagedObject

@since Unknown

Parameters

NameTypeDescription
managedObjectHolderAny

objectObject


Return Value

Type Description
Object

getAllDatacenters

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcDatacenter []

getProvisionedSpace

Shows datastore space in bytes guaranteed to the virtual machine. The entire space might not be used by the virtual machine if it has disks in thin provisioned format. Other virtual machines can occupy any unused space. @since Unknown

Parameters

NameTypeDescription
dataStoreVcDatastore


Return Value

Type Description
Number

unregisterVCenterServerInstance

Remove a vCenter Server instance @since Unknown

Parameters

NameTypeDescription
hostUrlString


Return Value

Type Description
None

deepClone

@since Unknown

Parameters

NameTypeDescription
oObject


Return Value

Type Description
Any

getAllVirtualApps

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcVirtualApp []

validateConnection

Validates vCenter connection details by attempting a login @since Unknown

Parameters

NameTypeDescription
hostNameString

portNumber

pathString

userNameString

passwordString


Return Value

Type Description
None

findSdkConnectionForUUID

Looks up sdkConnection by the given uuid. Returns null if can not find it. @since Unknown

Parameters

NameTypeDescription
uuidString


Return Value

Type Description
VcSdkConnection

getAllDatastoreFolders

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcDatastoreFolder []

getAllVmFolders

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcVmFolder []

getAllVirtualMachineSnapshots

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcVirtualMachineSnapshot []

getAllComputeResources

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcComputeResource []

validatePbmServiceAvailability

@since Unknown

Parameters

NameTypeDescription
pbmServiceUrlString


Return Value

Type Description
None

registerVCenterServerInstance

Register a vCenter Server instance for orchestration and returns it @since Unknown

Parameters

NameTypeDescription
enabledBoolean

hostNameString

portNumber

pathString

sessionPerUserBoolean

userNameString

passwordString

domainString

pbmUrlString

smsUrlString


Return Value

Type Description
VcSdkConnection

unregisterExtension

Unregisters a vCenter Server extension. @since Unknown

Parameters

NameTypeDescription
sdkConnectionVcSdkConnection

keyString


Return Value

Type Description
None

getManagedObjectsForTypesAndIds

Returns ManagedObjects from their types and IDs @since Unknown

Parameters

NameTypeDescription
sdkTypesString []

idsString []


Return Value

Type Description
VcManagedObject []

getAllHostSystems

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcHostSystem []

toManagedObjectRef

Convert one or many ManagedObject instance(s) to ManagedObjectReference(s). @since Unknown

Parameters

NameTypeDescription
objVcManagedObject


Return Value

Type Description
VcManagedObjectReference

getAllNetworks

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcNetwork []

updateVCenterServerInstance

Update a vCenter Server instance @since Unknown

Parameters

NameTypeDescription
hostUrlToUpdateString

enabledBoolean

hostNameString

portNumber

pathString

sessionPerUserBoolean

userNameString

passwordString

domainString

pbmUrlString

smsUrlString


Return Value

Type Description
None

getAllDatacenterFolders

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcDatacenterFolder []

getAllClusterComputeResources

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcClusterComputeResource []

refreshObjects

Refresh managed objects in the internal plugin cache with the remote inventory. Returns refreshed objects. @since Unknown

Parameters

NameTypeDescription
objAny


Return Value

Type Description
Any

getAllDistributedVirtualPortgroups

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcDistributedVirtualPortgroup []

getAllDatastores

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcDatastore []

getAllVirtualMachines

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcVirtualMachine []

getAllNetworkFolders

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcNetworkFolder []

getAllTasks

@since Unknown

Parameters

NameTypeDescription
additionalPropertyFiltersString []

queryString


Return Value

Type Description
VcTask []

registerExtension

Registers this vRealize Orchestrator instance as a vCenter Server extension. @since Unknown

Parameters

NameTypeDescription
sdkConnectionVcSdkConnection

addressString


Return Value

Type Description
None

currentTime

Returns the current time on the vCenter server. @since Unknown

Parameters

NameTypeDescription
sdkConnectionVcSdkConnection


Return Value

Type Description
Date