com.vmware.vcenter.guest

Class Domain

java.lang.Object

com.vmware.vcenter.guest.Domain

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class Domain
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The Domain class specifies the information needed to join a workgroup or domain. This structure maps to the Identification key in the sysprep.xml answer file. These values are transferred into the sysprep.xml file that VirtualCenter stores on the target virtual disk. For more information about performing unattended installation, check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This class was added in vSphere API 7.0.0.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Domain.Builder Builder class for Domain.
static class	Domain.Type The Type enumeration class defines the types of network the virtual machine should join to after the customization is completed.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Domain() Default constructor.
protected	Domain(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static Domain	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static Domain	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getDomain() The domain to which the virtual machine should be joined.
java.lang.String	getDomainOU() The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
char[]	getDomainPassword() The domain user password that has permission to join the getDomainUsername() after customization.
java.lang.String	getDomainUsername() The domain user that has permission to join the domain after virtual machine is joined.
Domain.Type	getType() The type of network to join after the customization.
java.lang.String	getWorkgroup() The workgroup that the virtual machine should join.
int	hashCode()
void	setDomain(java.lang.String domain) The domain to which the virtual machine should be joined.
void	setDomainOU(java.lang.String domainOU) The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
void	setDomainPassword(char[] domainPassword) The domain user password that has permission to join the getDomainUsername() after customization.
void	setDomainUsername(java.lang.String domainUsername) The domain user that has permission to join the domain after virtual machine is joined.
void	setType(Domain.Type type) The type of network to join after the customization.
void	setWorkgroup(java.lang.String workgroup) The workgroup that the virtual machine should join.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

Domain

public Domain()

Default constructor.

Domain

protected Domain(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getType

public Domain.Type getType()

The type of network to join after the customization. This property was added in vSphere API 7.0.0.0.

Returns:

The current value of the property.

setType

public void setType(Domain.Type type)

The type of network to join after the customization. This property was added in vSphere API 7.0.0.0.

Parameters:

type - New value for the property.

getWorkgroup

public java.lang.String getWorkgroup()

The workgroup that the virtual machine should join. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.WORKGROUP.

Returns:

The current value of the property.

setWorkgroup

public void setWorkgroup(java.lang.String workgroup)

The workgroup that the virtual machine should join. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.WORKGROUP.

Parameters:

workgroup - New value for the property.

getDomain

public java.lang.String getDomain()

The domain to which the virtual machine should be joined. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Returns:

The current value of the property.

setDomain

public void setDomain(java.lang.String domain)

The domain to which the virtual machine should be joined. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Parameters:

domain - New value for the property.

getDomainUsername

public java.lang.String getDomainUsername()

The domain user that has permission to join the domain after virtual machine is joined. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Returns:

The current value of the property.

setDomainUsername

public void setDomainUsername(java.lang.String domainUsername)

The domain user that has permission to join the domain after virtual machine is joined. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Parameters:

domainUsername - New value for the property.

getDomainPassword

public char[] getDomainPassword()

The domain user password that has permission to join the getDomainUsername() after customization. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Returns:

The current value of the property.

setDomainPassword

public void setDomainPassword(char[] domainPassword)

The domain user password that has permission to join the getDomainUsername() after customization. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Parameters:

domainPassword - New value for the property.

getDomainOU

public java.lang.String getDomainOU()

The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs. Refer to: https://docs.microsoft.com/en-us/windows-hardware/customize desktop/unattend/microsoft-windows-unattendedjoin- identification-machineobjectou. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Returns:

The current value of the property.

setDomainOU

public void setDomainOU(java.lang.String domainOU)

The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs. Refer to: https://docs.microsoft.com/en-us/windows-hardware/customize desktop/unattend/microsoft-windows-unattendedjoin- identification-machineobjectou. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is Domain.Type.DOMAIN.

Parameters:

domainOU - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static Domain _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static Domain _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.