< Back
Set-VMHostAuthentication
Post
NAME Set-VMHostAuthentication
SYNOPSIS
This cmdlet modifies the host authentication information.
SYNTAX
Set-VMHostAuthentication [-Domain] <String> [[-Username] <String>] [[-Password] <SecureString>] [-Credential
<PSCredential>] -JoinDomain -VMHostAuthentication <VMHostAuthentication[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-VMHostAuthentication [-Force] -LeaveDomain -VMHostAuthentication <VMHostAuthentication[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet modifies the host authentication information.
PARAMETERS
-Credential <PSCredential>
Specifies a credential object for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Domain <String>
Specifies a domain you want to join.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
If the value is $true, any existing permissions on the managed objects for Active Directory users are deleted
and the cmdlet completes. If the value is $false, the cmdlet cannot run if there are any existing permissions
on managed objects for Active Directory users.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-JoinDomain [<SwitchParameter>]
Indicates whether you want to join the specified domain.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LeaveDomain [<SwitchParameter>]
Indicates whether you want to leave the currently joined domain.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Password <SecureString>
Specifies a password for authentication.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Username <String>
Specifies a user name for authentication.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMHostAuthentication <VMHostAuthentication[]>
Specifies the VMHostAuthentication object you want to modify.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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 False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified VMHostAuthentication objects
NOTES
-------------------------- Example 1 --------------------------
$vmhost | Get-VMHostAuthentication | Set-VMHostAuthentication -JoinDomain -Domain "DomainName.com" -User
"Username1" -Password "Password1"
Include an ESX host in a domain.
-------------------------- Example 2 --------------------------
$vmhost | Get-VMHostAuthentication | Set-VMHostAuthentication -LeaveDomain
Exclude an ESX host from a domain.
-------------------------- Example 3 --------------------------
$vmhost | 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: https://code.vmware.com/doc/preview?id= ... ation.html
Get-VMHostAuthentication
SYNOPSIS
This cmdlet modifies the host authentication information.
SYNTAX
Set-VMHostAuthentication [-Domain] <String> [[-Username] <String>] [[-Password] <SecureString>] [-Credential
<PSCredential>] -JoinDomain -VMHostAuthentication <VMHostAuthentication[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-VMHostAuthentication [-Force] -LeaveDomain -VMHostAuthentication <VMHostAuthentication[]> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet modifies the host authentication information.
PARAMETERS
-Credential <PSCredential>
Specifies a credential object for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Domain <String>
Specifies a domain you want to join.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
If the value is $true, any existing permissions on the managed objects for Active Directory users are deleted
and the cmdlet completes. If the value is $false, the cmdlet cannot run if there are any existing permissions
on managed objects for Active Directory users.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-JoinDomain [<SwitchParameter>]
Indicates whether you want to join the specified domain.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LeaveDomain [<SwitchParameter>]
Indicates whether you want to leave the currently joined domain.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Password <SecureString>
Specifies a password for authentication.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Username <String>
Specifies a user name for authentication.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMHostAuthentication <VMHostAuthentication[]>
Specifies the VMHostAuthentication object you want to modify.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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 False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified VMHostAuthentication objects
NOTES
-------------------------- Example 1 --------------------------
$vmhost | Get-VMHostAuthentication | Set-VMHostAuthentication -JoinDomain -Domain "DomainName.com" -User
"Username1" -Password "Password1"
Include an ESX host in a domain.
-------------------------- Example 2 --------------------------
$vmhost | Get-VMHostAuthentication | Set-VMHostAuthentication -LeaveDomain
Exclude an ESX host from a domain.
-------------------------- Example 3 --------------------------
$vmhost | 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: https://code.vmware.com/doc/preview?id= ... ation.html
Get-VMHostAuthentication