Managed Object - CustomizationSpecManager(vim.CustomizationSpecManager)

Property of
ServiceContent
See also
CustomizationSpecInfo, CustomizationSpecItem
Since
2.0


Managed Object Description

The CustomizationSpecManager managed object is used to manage customization specifications stored on the VirtualCenter server.

Properties

Name Type Description
encryptionKey* Pxsd:byte[]

Gets a binary public encryption key that can be used to encrypt passwords in stored specifications.
info* PCustomizationSpecInfo[]

Gets a list of information on available specifications.
*May not be presentPRequired privilege - see tooltip for details

Methods

Methods defined in this Managed Object
CheckCustomizationResources, CreateCustomizationSpec, CustomizationSpecItemToXml, DeleteCustomizationSpec, DoesCustomizationSpecExist, DuplicateCustomizationSpec, GetCustomizationSpec, OverwriteCustomizationSpec, RenameCustomizationSpec, XmlToCustomizationSpecItem

CheckCustomizationResources(checkResources)

Validate that required resources are available on the server to customize a particular guest operating system. These would include sysprep for Windows and the debugfs and changefs volume editors for Linux guests.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
guestOs Pxsd:string

Short name from the guest OS descriptor list describing the OS we intend to customize.

Since 2.0
P Required privilege: guestOs

Return Value

Type Description
None

Faults

Type Description
CustomizationFault
MissingLinuxCustResources
MissingWindowsCustResources
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UncustomizableGuest

Events

Type
None

Show WSDL type definition



CreateCustomizationSpec(create)

Creates a new specification.
Required Privileges
VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
item PCustomizationSpecItem

Since 2.0
P Required privilege: item

Return Value

Type Description
None

Faults

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

Events

Type
None

Show WSDL type definition



CustomizationSpecItemToXml(specItemToXml)

Converts a specification item to XML text
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
item PCustomizationSpecItem

Since 2.0
P Required privilege: item

Return Value

Type Description
xsd:string

Faults

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

Events

Type
None

Show WSDL type definition



DeleteCustomizationSpec(delete)

Deletes a specification.
Required Privileges
VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
name Pxsd:string

Since 2.0
P Required privilege: name

Return Value

Type Description
None

Faults

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

Events

Type
None

Show WSDL type definition



DoesCustomizationSpecExist(exists)

Whether or not a specification exists.
Required Privileges
VirtualMachine.Provisioning.ReadCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
name Pxsd:string

Since 2.0
P Required privilege: name

Return Value

Type Description
xsd:boolean

Faults

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

Events

Type
None

Show WSDL type definition



DuplicateCustomizationSpec(duplicate)

Duplicates a specification.
Required Privileges
VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
name Pxsd:string

Since 2.0
newName Pxsd:string

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None

Show WSDL type definition



GetCustomizationSpec(get)

Obtains a specification for the given name.
Required Privileges
VirtualMachine.Provisioning.ReadCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
name Pxsd:string

Unique name identifying the requested customization specification.

Since 2.0
P Required privilege: name

Return Value

Type Description
CustomizationSpecItem

Faults

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

Events

Type
None

Show WSDL type definition



OverwriteCustomizationSpec(overwrite)

Overwrites an existing specification, possibly after retrieving (by using 'get') and editing it. If, based on the item's changeVersion value, the overwrite process detects that the specification has changed since its retrieval, then the API uses the SpecModified exception to warn the client that he might overwrite another client's change.
Required Privileges
VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
item PCustomizationSpecItem

Since 2.0
P Required privilege: item

Return Value

Type Description
None

Faults

Type Description
CannotDecryptPasswords
ConcurrentAccess
CustomizationFault
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RenameCustomizationSpec(rename)

Renames a specification.
Required Privileges
VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
name Pxsd:string

Since 2.0
newName Pxsd:string

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None

Show WSDL type definition



XmlToCustomizationSpecItem(xmlToSpecItem)

Converts an XML string to a specification item
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the CustomizationSpecManager used to make the method call.
specItemXml Pxsd:string

Since 2.0
P Required privilege: specItemXml

Return Value

Type Description
CustomizationSpecItem

Faults

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

Events

Type
None

Show WSDL type definition