Host Active Directory Authentication Enable Smart Card Authentication

Deprecated as of vSphere API 8.0U3, and there is no replacement for it.

Enables console authentication using a local smart card and reader.

To take effect this feature requires an active domain membership to a domain with users configured to authenticate using smart cards.

Required privileges: Host.Config.AuthenticationStore

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostActiveDirectoryAuthentication/{moId}/EnableSmartCardAuthentication

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostActiveDirectoryAuthentication/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

ActiveDirectoryFault: if the active directory client could not be reconfigured.

HostConfigFault: if the host configuration prevents smart card authentication from being enabled.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Host Active Directory Authentication Disable Smart Card Authentication

POST