esxi_auth_proxy

ESXi vSphere Authentication Proxy (CAM) configuration via SOAP/pyVmomi.

Covers the 912-controls requirement ESXi.enable-auth-proxy: enable the vSphere Authentication Proxy so ESXi hosts can join Active Directory without AD credentials being sent from the client that runs the join.

The join itself is done through the host’s configManager.authenticationManager.JoinDomainWithCAM_Task — that is the pyVmomi call the auth proxy is designed to serve. Two advanced settings control the ESXi-side plumbing:

  • UserVars.ActiveDirectoryVerifyCAMCertificate — 1 to require a valid CAM (Camellia) certificate, 0 to skip verification.

  • Config.HostAgent.plugins.vmauthenticationservice.authproxyaddress — hostname/IP of the CAM appliance.

The advanced-setting keys are stable across ESXi 7.0/8.0/9.x; the JoinDomainWithCAM_Task shape is also stable (domainName, camServer). If a lab surfaces a divergence, prefer the shape ESXi actually accepts and log an issue.

saltext.vcf.clients.esxi_auth_proxy.get_config(opts, host, profile=None)[source]

Return CAM configuration and current AD join state for host.

{
    "cam_address": "cam.example.com" | None,
    "verify_cam_cert": True | False | None,
    "joined": bool,
    "domain": str | None,
}
saltext.vcf.clients.esxi_auth_proxy.set_config(opts, host, cam_address=None, verify_cam_cert=None, profile=None)[source]

Set CAM advanced settings on host.

Both fields are optional; passing None leaves that value alone. verify_cam_cert is coerced to the 0/1 int the setting stores.

saltext.vcf.clients.esxi_auth_proxy.join_domain_via_cam(opts, host, domain_name, cam_server, profile=None)[source]

Join host to domain_name using the CAM (auth proxy) at cam_server.

Calls HostActiveDirectoryAuthentication.JoinDomainWithCAM_Task. Returns the task moId; callers that need to block should wrap in saltext.vcf.utils.vim.wait_for_task().

saltext.vcf.clients.esxi_auth_proxy.leave_domain(opts, host, force=False, profile=None)[source]

Leave the current AD domain via LeaveCurrentDomain_Task.