Managed Object - CustomizationSpecManager

Property of: ServiceContent
See also: CustomizationSpecInfo, CustomizationSpecItem

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

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	xsd:string	Short name from the guest OS descriptor list describing the OS we intend to customize.

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:vim25="urn:vim25" name="CheckCustomizationResources" type="vim25:CheckCustomizationResourcesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CheckCustomizationResourcesResponse">
            <complexType/>
         </element>

CreateCustomizationSpec

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	CustomizationSpecItem

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:vim25="urn:vim25" name="CreateCustomizationSpec" type="vim25:CreateCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateCustomizationSpecResponse">
            <complexType/>
         </element>

CustomizationSpecItemToXml

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	CustomizationSpecItem

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:vim25="urn:vim25" name="CustomizationSpecItemToXml" type="vim25:CustomizationSpecItemToXmlRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CustomizationSpecItemToXmlResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

DeleteCustomizationSpec

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	xsd:string

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:vim25="urn:vim25" name="DeleteCustomizationSpec" type="vim25:DeleteCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DeleteCustomizationSpecResponse">
            <complexType/>
         </element>

DoesCustomizationSpecExist

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	xsd:string

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:vim25="urn:vim25" name="DoesCustomizationSpecExist" type="vim25:DoesCustomizationSpecExistRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DoesCustomizationSpecExistResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

DuplicateCustomizationSpec

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	xsd:string
newName	xsd:string

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:vim25="urn:vim25" name="DuplicateCustomizationSpec" type="vim25:DuplicateCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DuplicateCustomizationSpecResponse">
            <complexType/>
         </element>

GetCustomizationSpec

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	xsd:string	Unique name identifying the requested customization specification.

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:vim25="urn:vim25" name="GetCustomizationSpec" type="vim25:GetCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetCustomizationSpecResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:CustomizationSpecItem"/>
               </sequence>
            </complexType>
         </element>

OverwriteCustomizationSpec

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the CustomizationSpecManager used to make the method call.
item	CustomizationSpecItem

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:vim25="urn:vim25" name="OverwriteCustomizationSpec" type="vim25:OverwriteCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="OverwriteCustomizationSpecResponse">
            <complexType/>
         </element>

RenameCustomizationSpec

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	xsd:string
newName	xsd:string

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:vim25="urn:vim25" name="RenameCustomizationSpec" type="vim25:RenameCustomizationSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RenameCustomizationSpecResponse">
            <complexType/>
         </element>

XmlToCustomizationSpecItem

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	xsd:string

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:vim25="urn:vim25" name="XmlToCustomizationSpecItem" type="vim25:XmlToCustomizationSpecItemRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="XmlToCustomizationSpecItemResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:CustomizationSpecItem"/>
               </sequence>
            </complexType>
         </element>