Managed Object - HostActiveDirectoryAuthentication

Extends: HostDirectoryStore
Since: vSphere API 4.1

Managed Object Description

Properties

Name	Type	Description
None
Properties inherited from HostDirectoryStore
None
Properties inherited from HostAuthenticationStore
info

Methods

Methods defined in this Managed Object
DisableSmartCardAuthentication, EnableSmartCardAuthentication, ImportCertificateForCAM_Task, InstallSmartCardTrustAnchor, JoinDomain_Task, JoinDomainWithCAM_Task, LeaveCurrentDomain_Task, ListSmartCardTrustAnchors, RemoveSmartCardTrustAnchor, RemoveSmartCardTrustAnchorByFingerprint, ReplaceSmartCardTrustAnchors
Methods inherited from HostDirectoryStore
None
Methods inherited from HostAuthenticationStore
None

DisableSmartCardAuthentication

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostActiveDirectoryAuthentication used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
ActiveDirectoryFault
HostConfigFault
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

EnableSmartCardAuthentication

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostActiveDirectoryAuthentication used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
ActiveDirectoryFault
HostConfigFault
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

ImportCertificateForCAM_Task

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

certPath P

xsd:string

Since vSphere API 5.0

camServer P

xsd:string

Since vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
ActiveDirectoryFault
FileNotFound
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

InstallSmartCardTrustAnchor

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

cert P

xsd:string

Since vSphere API 6.0

P Required privilege: cert

Return Value

Type	Description
None

Faults

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

JoinDomain_Task

Required Privileges: Host.Config.AuthenticationStore

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostActiveDirectoryAuthentication used to make the method call.
domainName P	xsd:string	*Since* vSphere API 4.1
userName P	xsd:string	*Since* vSphere API 4.1
password P	xsd:string	*Since* vSphere API 4.1

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
ActiveDirectoryFault
HostConfigFault
InvalidLogin
InvalidState
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None

JoinDomainWithCAM_Task

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

domainName P

xsd:string

Since vSphere API 5.0

camServer P

xsd:string

Since vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
ActiveDirectoryFault
HostConfigFault
InvalidState
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None

LeaveCurrentDomain_Task

Required Privileges: Host.Config.AuthenticationStore

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

force P

xsd:boolean

Since vSphere API 4.1

P Required privilege: force

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
ActiveDirectoryFault
AuthMinimumAdminPermission
InvalidState
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None

ListSmartCardTrustAnchors

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostActiveDirectoryAuthentication used to make the method call.

Return Value

Type	Description
xsd:string[]

Faults

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

RemoveSmartCardTrustAnchor

Deprecated.

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

issuer P

xsd:string

Since vSphere API 6.0

serial P

xsd:string

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

RemoveSmartCardTrustAnchorByFingerprint

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

fingerprint P

xsd:string

Since vSphere API 6.0

digest P

xsd:string

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

ReplaceSmartCardTrustAnchors

Required Privileges: Host.Config.AuthenticationStore
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostActiveDirectoryAuthentication used to make the method call.

certs* P

xsd:string[]

Since vSphere API 6.0

*Need not be set P Required privilege: certs

Return Value

Type	Description
None

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