powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-VMHostAuthentication



NAME
Set-VMHostAuthentication

SYNOPSIS
Modifies the host authentication information.

SYNTAX
Set-VMHostAuthentication [-Domain] [[-Username] ] [[-Password] ] [-Credential dential>] -JoinDomain -VMHostAuthentication [-WhatIf] [-Confirm] []

Set-VMHostAuthentication [-Force] -LeaveDomain -VMHostAuthentication [-WhatIf] [-Confirm]
[]


DESCRIPTION
Modifies the host authentication information.


PARAMETERS
-Domain
Specify a domain you want to join.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Username
Specify user name for authentication.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Password
Specify password for authentication.

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Credential
Specify a credential object for authentication.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-JoinDomain
Indicate whether you want o join the specified domain.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VMHostAuthentication
Specify the VMHostAuthentication object you want to modify.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force
If the value is $true, any existing permissions on the managed objects for Active Directory users are deleted a
nd the cmdlet completes. If the value is $false, the cmdlet canno run if there are any existing permissions on
managed objects for Active Directory users.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-LeaveDomain
Indicate whether you want to leave the currently joined domain.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VMHostAuthentication


NOTES




-------------- Example 1 --------------

C:\PS>$host | Get-VMHostAuthentication | Set-VMHostAuthentication -Domain someDomain.vmware.com -User username -Pas
sword pass


Include an ESX host in a domain.





-------------- Example 2 --------------

C:\PS>$host | Get-VMHostAuthentication | Set-VMHostAuthentication -LeaveDomain


Exclude an ESX host from a domain.





-------------- Example 3 --------------

C:\PS>$host | Get-VMHostAuthentication | Set-VMHostAuthentication -LeaveDomain -Force


Exclude an ESX host from a domain. If AD account permissions are defined on the host, they will be removed.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-VMHostAuthentication.html
Get-VMHostAuthentication