vmware::vcenter::guest::CustomizationSpecs Interface Reference

The CustomizationSpecs interface provides methods to manage guest customization specifications in the vCenter Server. More...

Inherited by vmware::vcenter::guest::CustomizationSpecsStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.List < vmware.vcenter.guest.CustomizationSpecsTypes.Summary >	List (vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec filter)
	Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .
global::System.Collections.Generic.List < vmware.vcenter.guest.CustomizationSpecsTypes.Summary >	List (vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.guest.CustomizationSpecsTypes.Summary > >	ListAsync (vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec filter)
	Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.guest.CustomizationSpecsTypes.Summary > >	ListAsync (vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .
string	Create (vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec spec)
	Creates a customization specification.
string	Create (vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a customization specification.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec spec)
	Creates a customization specification.
global::System.Threading.Tasks.Task < string >	CreateAsync (vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Creates a customization specification.
vmware.vcenter.guest.CustomizationSpecsTypes.Info	Get (string name)
	Returns the guest customization specification from vCenter with the specified identifier.
vmware.vcenter.guest.CustomizationSpecsTypes.Info	Get (string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the guest customization specification from vCenter with the specified identifier.
global::System.Threading.Tasks.Task < vmware.vcenter.guest.CustomizationSpecsTypes.Info >	GetAsync (string name)
	Returns the guest customization specification from vCenter with the specified identifier.
global::System.Threading.Tasks.Task < vmware.vcenter.guest.CustomizationSpecsTypes.Info >	GetAsync (string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the guest customization specification from vCenter with the specified identifier.
void	Set (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Spec spec)
	Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.
void	Set (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Spec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.
global::System.Threading.Tasks.Task	SetAsync (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Spec spec)
	Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.
global::System.Threading.Tasks.Task	SetAsync (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Spec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.
void	Delete (string name)
	Deletes a customization specification with the specified identifier.
void	Delete (string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a customization specification with the specified identifier.
global::System.Threading.Tasks.Task	DeleteAsync (string name)
	Deletes a customization specification with the specified identifier.
global::System.Threading.Tasks.Task	DeleteAsync (string name, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Deletes a customization specification with the specified identifier.
string	Export (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Format format)
	Returns the content of the customization specification in the specified format.
string	Export (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Format format, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the content of the customization specification in the specified format.
global::System.Threading.Tasks.Task < string >	ExportAsync (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Format format)
	Returns the content of the customization specification in the specified format.
global::System.Threading.Tasks.Task < string >	ExportAsync (string name, vmware.vcenter.guest.CustomizationSpecsTypes.Format format, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the content of the customization specification in the specified format.
vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec	ImportSpecification (string customizationSpec)
	Converts a well formatted string to a CustomizationSpecs.CreateSpec .
vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec	ImportSpecification (string customizationSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Converts a well formatted string to a CustomizationSpecs.CreateSpec .
global::System.Threading.Tasks.Task < vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec >	ImportSpecificationAsync (string customizationSpec)
	Converts a well formatted string to a CustomizationSpecs.CreateSpec .
global::System.Threading.Tasks.Task < vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec >	ImportSpecificationAsync (string customizationSpec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Converts a well formatted string to a CustomizationSpecs.CreateSpec .

---

Detailed Description

The CustomizationSpecs interface provides methods to manage guest customization specifications in the vCenter Server.

This interface was added in vSphere API 6.7.1.

---

Member Function Documentation

string vmware::vcenter::guest::CustomizationSpecs::Create

(

vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec

spec

)

Creates a customization specification.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a customization specification is already present with the same name.
vmware.vapi.std.errors.InvalidArgument	if the specified specification is not a valid one.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

spec	The information i.e. name, description and the settings i.e hostname, ip address etc for the new customization specification that needs to be created.

Returns:

The name of the customization specification that is created. The result will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

string vmware::vcenter::guest::CustomizationSpecs::Create	(	vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a customization specification.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a customization specification is already present with the same name.
vmware.vapi.std.errors.InvalidArgument	if the specified specification is not a valid one.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

spec	The information i.e. name, description and the settings i.e hostname, ip address etc for the new customization specification that needs to be created.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The name of the customization specification that is created. The result will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::guest::CustomizationSpecs::CreateAsync	(	vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Creates a customization specification.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a customization specification is already present with the same name.
vmware.vapi.std.errors.InvalidArgument	if the specified specification is not a valid one.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

spec	The information i.e. name, description and the settings i.e hostname, ip address etc for the new customization specification that needs to be created.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The name of the customization specification that is created. The result will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::guest::CustomizationSpecs::CreateAsync

(

vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec

spec

)

Creates a customization specification.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.AlreadyExists	if a customization specification is already present with the same name.
vmware.vapi.std.errors.InvalidArgument	if the specified specification is not a valid one.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

spec	The information i.e. name, description and the settings i.e hostname, ip address etc for the new customization specification that needs to be created.

Returns:

The name of the customization specification that is created. The result will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

void vmware::vcenter::guest::CustomizationSpecs::Delete

(

string

name

)

Deletes a customization specification with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

void vmware::vcenter::guest::CustomizationSpecs::Delete	(	string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes a customization specification with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task vmware::vcenter::guest::CustomizationSpecs::DeleteAsync

(

string

name

)

Deletes a customization specification with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task vmware::vcenter::guest::CustomizationSpecs::DeleteAsync	(	string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Deletes a customization specification with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

string vmware::vcenter::guest::CustomizationSpecs::Export	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Format	format
	)

Returns the content of the customization specification in the specified format.

Note that any passwords in the customization specification will be set to blank values during the export method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If value of format is not valid.
vmware.vapi.std.errors.NotFound	if the customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that has to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
format	The format in which the customization specification has to be returned.

Returns:

The string representation of the customization specification in the specified format.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

string vmware::vcenter::guest::CustomizationSpecs::Export	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Format	format,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the content of the customization specification in the specified format.

Note that any passwords in the customization specification will be set to blank values during the export method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If value of format is not valid.
vmware.vapi.std.errors.NotFound	if the customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that has to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
format	The format in which the customization specification has to be returned.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The string representation of the customization specification in the specified format.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::guest::CustomizationSpecs::ExportAsync	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Format	format
	)

Returns the content of the customization specification in the specified format.

Note that any passwords in the customization specification will be set to blank values during the export method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If value of format is not valid.
vmware.vapi.std.errors.NotFound	if the customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that has to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
format	The format in which the customization specification has to be returned.

Returns:

The string representation of the customization specification in the specified format.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::guest::CustomizationSpecs::ExportAsync	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Format	format,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the content of the customization specification in the specified format.

Note that any passwords in the customization specification will be set to blank values during the export method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If value of format is not valid.
vmware.vapi.std.errors.NotFound	if the customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that has to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
format	The format in which the customization specification has to be returned.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

The string representation of the customization specification in the specified format.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

vmware.vcenter.guest.CustomizationSpecsTypes.Info vmware::vcenter::guest::CustomizationSpecs::Get

(

string

name

)

Returns the guest customization specification from vCenter with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Returns:

A customization spec with the specified identifier.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

vmware.vcenter.guest.CustomizationSpecsTypes.Info vmware::vcenter::guest::CustomizationSpecs::Get	(	string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the guest customization specification from vCenter with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

A customization spec with the specified identifier.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.guest.CustomizationSpecsTypes.Info> vmware::vcenter::guest::CustomizationSpecs::GetAsync

(

string

name

)

Returns the guest customization specification from vCenter with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .

Returns:

A customization spec with the specified identifier.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.guest.CustomizationSpecsTypes.Info> vmware::vcenter::guest::CustomizationSpecs::GetAsync	(	string	name,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the guest customization specification from vCenter with the specified identifier.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

A customization spec with the specified identifier.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec vmware::vcenter::guest::CustomizationSpecs::ImportSpecification

(

string

customizationSpec

)

Converts a well formatted string to a CustomizationSpecs.CreateSpec .

The resulting object can be passed to CustomizationSpecs.Create method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the specified content cannot be properly converted into a proper valid CustomizationSpecs.CreateSpec object.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

customizationSpec

content to be converted to the spec.

Returns:

A proper specification of type CustomizationSpecs.CreateSpec

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec vmware::vcenter::guest::CustomizationSpecs::ImportSpecification	(	string	customizationSpec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Converts a well formatted string to a CustomizationSpecs.CreateSpec .

The resulting object can be passed to CustomizationSpecs.Create method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the specified content cannot be properly converted into a proper valid CustomizationSpecs.CreateSpec object.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

customizationSpec	content to be converted to the spec.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

A proper specification of type CustomizationSpecs.CreateSpec

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec> vmware::vcenter::guest::CustomizationSpecs::ImportSpecificationAsync

(

string

customizationSpec

)

Converts a well formatted string to a CustomizationSpecs.CreateSpec .

The resulting object can be passed to CustomizationSpecs.Create method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the specified content cannot be properly converted into a proper valid CustomizationSpecs.CreateSpec object.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

customizationSpec

content to be converted to the spec.

Returns:

A proper specification of type CustomizationSpecs.CreateSpec

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.guest.CustomizationSpecsTypes.CreateSpec> vmware::vcenter::guest::CustomizationSpecs::ImportSpecificationAsync	(	string	customizationSpec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Converts a well formatted string to a CustomizationSpecs.CreateSpec .

The resulting object can be passed to CustomizationSpecs.Create method. This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the specified content cannot be properly converted into a proper valid CustomizationSpecs.CreateSpec object.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

customizationSpec	content to be converted to the spec.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

A proper specification of type CustomizationSpecs.CreateSpec

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Collections.Generic.List<vmware.vcenter.guest.CustomizationSpecsTypes.Summary> vmware::vcenter::guest::CustomizationSpecs::List

(

vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec

filter

)

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the CustomizationSpecs.FilterSpec.OSType field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter

Specification of matching guest customization specifications for which information should be returned. If null, the behavior is equivalent to a CustomizationSpecs.FilterSpec with all fields null which means all guest customization specifications match the filter.

Returns:

Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Collections.Generic.List<vmware.vcenter.guest.CustomizationSpecsTypes.Summary> vmware::vcenter::guest::CustomizationSpecs::List	(	vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the CustomizationSpecs.FilterSpec.OSType field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter	Specification of matching guest customization specifications for which information should be returned. If null, the behavior is equivalent to a CustomizationSpecs.FilterSpec with all fields null which means all guest customization specifications match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.guest.CustomizationSpecsTypes.Summary> > vmware::vcenter::guest::CustomizationSpecs::ListAsync

(

vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec

filter

)

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the CustomizationSpecs.FilterSpec.OSType field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter

Specification of matching guest customization specifications for which information should be returned. If null, the behavior is equivalent to a CustomizationSpecs.FilterSpec with all fields null which means all guest customization specifications match the filter.

Returns:

Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.guest.CustomizationSpecsTypes.Summary> > vmware::vcenter::guest::CustomizationSpecs::ListAsync	(	vmware.vcenter.guest.CustomizationSpecsTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec .

This method was added in vSphere API 6.7.1.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the CustomizationSpecs.FilterSpec.OSType field contains a value that is not supported by the server.
vmware.vapi.std.errors.UnableToAllocateResource	if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

filter	Specification of matching guest customization specifications for which information should be returned. If null, the behavior is equivalent to a CustomizationSpecs.FilterSpec with all fields null which means all guest customization specifications match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec .

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

void vmware::vcenter::guest::CustomizationSpecs::Set	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Spec	spec
	)

Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If, based on the item's fingerprint value, the set process detects that the specification has changed since its retrieval, then the method throws InvalidArgument exception to warn the client that he might overwrite another client's change.
vmware.vapi.std.errors.InvalidArgument	If the settings in spec are not valid.
vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be set. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
spec	The new specification that will overwrite the existing specification.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

void vmware::vcenter::guest::CustomizationSpecs::Set	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Spec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If, based on the item's fingerprint value, the set process detects that the specification has changed since its retrieval, then the method throws InvalidArgument exception to warn the client that he might overwrite another client's change.
vmware.vapi.std.errors.InvalidArgument	If the settings in spec are not valid.
vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be set. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
spec	The new specification that will overwrite the existing specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task vmware::vcenter::guest::CustomizationSpecs::SetAsync	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Spec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If, based on the item's fingerprint value, the set process detects that the specification has changed since its retrieval, then the method throws InvalidArgument exception to warn the client that he might overwrite another client's change.
vmware.vapi.std.errors.InvalidArgument	If the settings in spec are not valid.
vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be set. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
spec	The new specification that will overwrite the existing specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

global::System.Threading.Tasks.Task vmware::vcenter::guest::CustomizationSpecs::SetAsync	(	string	name,
		vmware.vcenter.guest.CustomizationSpecsTypes.Spec	spec
	)

Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.Get ) and editing it.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	If, based on the item's fingerprint value, the set process detects that the specification has changed since its retrieval, then the method throws InvalidArgument exception to warn the client that he might overwrite another client's change.
vmware.vapi.std.errors.InvalidArgument	If the settings in spec are not valid.
vmware.vapi.std.errors.NotFound	if a customization specification is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.

Parameters:

name	The name of the customization specification that needs to be set. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec .
spec	The new specification that will overwrite the existing specification.

Implemented in vmware::vcenter::guest::CustomizationSpecsStub.

---

The documentation for this interface was generated from the following file:

• CustomizationSpecs.cs