# 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* P | xsd:byte[] | Gets a binary public encryption key that can be used to encrypt passwords in stored specifications.
info* P | CustomizationSpecInfo[] | 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
guestOs P | xsd: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 |
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CheckCustomizationResources" type="sms:CheckCustomizationResourcesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CheckCustomizationResourcesResponse"> <complexType/> </element>

# CreateCustomizationSpec(create)

Creates a new specification.

Required Privileges
  VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
item P | CustomizationSpecItem | Since 2.0

P Required privilege: item

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AlreadyExists |
CannotDecryptPasswords |
CustomizationFault |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateCustomizationSpec" type="sms:CreateCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateCustomizationSpecResponse"> <complexType/> </element>

# CustomizationSpecItemToXml(specItemToXml)

Converts a specification item to XML text

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
item P | CustomizationSpecItem | Since 2.0

P Required privilege: item

Return Value

Type | Description
--- | ---
xsd:string |

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CustomizationSpecItemToXml" type="sms:CustomizationSpecItemToXmlRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CustomizationSpecItemToXmlResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string"/> </sequence> </complexType> </element>

# DeleteCustomizationSpec(delete)

Deletes a specification.

Required Privileges
  VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
name P | xsd:string | Since 2.0

P Required privilege: name

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
NotFound |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteCustomizationSpec" type="sms:DeleteCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteCustomizationSpecResponse"> <complexType/> </element>

# DoesCustomizationSpecExist(exists)

Whether or not a specification exists.

Required Privileges
  VirtualMachine.Provisioning.ReadCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
name P | xsd:string | Since 2.0

P Required privilege: name

Return Value

Type | Description
--- | ---
xsd:boolean |

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DoesCustomizationSpecExist" type="sms:DoesCustomizationSpecExistRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DoesCustomizationSpecExistResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# DuplicateCustomizationSpec(duplicate)

Duplicates a specification.

Required Privileges
  VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
name P | xsd:string | Since 2.0
newName P | xsd:string | Since 2.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AlreadyExists |
NotFound |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DuplicateCustomizationSpec" type="sms:DuplicateCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DuplicateCustomizationSpecResponse"> <complexType/> </element>

# GetCustomizationSpec(get)

Obtains a specification for the given name.

Required Privileges
  VirtualMachine.Provisioning.ReadCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
name P | xsd:string | Unique name identifying the requested customization specification. Since 2.0

P Required privilege: name

Return Value

Type | Description
--- | ---
CustomizationSpecItem |

Faults

Type | Description
--- | ---
NotFound |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="GetCustomizationSpec" type="sms:GetCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="GetCustomizationSpecResponse"> <complexType> <sequence> <element name="returnval" type="sms:CustomizationSpecItem"/> </sequence> </complexType> </element>

# 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 clients that they might overwrite another client's change.

Required Privileges
  VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
item P | CustomizationSpecItem | Since 2.0

P Required privilege: item

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
CannotDecryptPasswords |
ConcurrentAccess |
CustomizationFault |
NotFound |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="OverwriteCustomizationSpec" type="sms:OverwriteCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="OverwriteCustomizationSpecResponse"> <complexType/> </element>

# RenameCustomizationSpec(rename)

Renames a specification.

Required Privileges
  VirtualMachine.Provisioning.ModifyCustSpecs

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
name P | xsd:string | Since 2.0
newName P | xsd:string | Since 2.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AlreadyExists |
NotFound |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RenameCustomizationSpec" type="sms:RenameCustomizationSpecRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RenameCustomizationSpecResponse"> <complexType/> </element>

# XmlToCustomizationSpecItem(xmlToSpecItem)

Converts an XML string to a specification item

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the CustomizationSpecManager used to make the method call.
specItemXml P | xsd:string | Since 2.0

P Required privilege: specItemXml

Return Value

Type | Description
--- | ---
CustomizationSpecItem |

Faults

Type | Description
--- | ---
CustomizationFault |
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="XmlToCustomizationSpecItem" type="sms:XmlToCustomizationSpecItemRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="XmlToCustomizationSpecItemResponse"> <complexType> <sequence> <element name="returnval" type="sms:CustomizationSpecItem"/> </sequence> </complexType> </element>