New-VMHostAccount
This cmdlet creates a new host user or group account using the provided parameters.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String | named |
|
Specifies an ID for the new host account. | optional |
|
String[] | named |
|
If the GroupAccount parameter is set to $true, use AssignUsers to specify the users that belong to the newly created group account. | optional |
|
SwitchParameter | named |
|
Indicates that the new host account is a group account. Starting with ESXi 5.1, this parameter is not supported. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. Passing values to this parameter through a pipeline is deprecated and will be deactivated in a future release. |
[-Password]
<String>
-Id <String>
[-AssignGroups <String[]>]
[-Description <String>]
[-GrantShellAccess]
[-Server <VIServer[]>]
[-UserAccount]
[CommonParameters]
-Id <String>
[-AssignGroups <String[]>]
[-Description <String>]
[-GrantShellAccess]
[-Server <VIServer[]>]
[-UserAccount]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String | 1 |
|
Specifies a password for the new host account. | required |
|
String | named |
|
Specifies an ID for the new host account. | optional |
|
String[] | named |
|
If the UserAccount parameter is set to $true, use AssignGroups to specify the groups to which the newly created user belongs. | optional |
|
String | named |
|
Provide a description of the new host account. The maximum length of the text is 255 symbols. | optional |
|
SwitchParameter | named |
|
Indicates that the new account is allowed to access the ESX shell. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. Passing values to this parameter through a pipeline is deprecated and will be deactivated in a future release. | optional |
|
SwitchParameter | named |
|
Indicates that the new host account is a user account. |
Output
VMware.VimAutomation.ViCore.Types.V1.Host.Account.HostAccount
Examples
Example 1
New-VMHostAccount -ID MyUser1 -Password MyPassword1 -UserAccount
Creates a user account with a specified user ID and password. The user account is created on the default server.
Example 2
$myUser1 = Get-VMHostAccount -ID MyUser1 -User
New-VMHostAccount -Id MyGroup1 -GroupAccount -AssignUsers $myUser1
Creates a group account with a specified ID and assigns a specified user to the group account. Starting with ESXi 5.1, you cannot create group host accounts.
Related Commands
VMHost
This cmdlet retrieves the hosts on a vCenter Server system.
This cmdlet adds a host to be managed by a vCenter Server system.
This cmdlet moves hosts to another location.
This cmdlet restarts the specified hosts.
This cmdlet modifies the configuration of the host.
This cmdlet starts the specified hosts.
This cmdlet powers off the specified hosts.
This cmdlet suspends hosts.
This cmdlet removes the specified hosts from the inventory.
VMHostAccount
This cmdlet retrieves the host accounts available on a vCenter Server system.
This cmdlet configures a host account.
This cmdlet removes the specified host accounts.
This cmdlet creates a new host user or group account.
VMHostAdvancedConfiguration
This cmdlet retrieves the advanced configuration of the hosts.
This cmdlet modifies the advanced configuration settings of a host.
VMHostAuthentication
This cmdlet retrieves authentication information for the specified hosts.
This cmdlet modifies the host authentication information.
VMHostAvailableTimeZone
This cmdlet retrieves the time zones available on the specified host.
VMHostDiagnosticPartition
This cmdlet retrieves a list of the diagnostic partitions on the specified hosts.
This cmdlet activates or deactivates the diagnostic partitions of hosts.
VMHostDisk
This cmdlet retrieves information about the specified SCSI LUN disk.
VMHostDiskPartition
This cmdlet retrieves the partitions of a host disk (LUN).
This cmdlet formats a new VMFS (Virtual Machine File System) on each of the specified host disk partitions.
VMHostFirewallDefaultPolicy
This cmdlet retrieves the firewall default policy of the specified hosts.
This cmdlet sets the default policy for the specified host firewall.
VMHostFirewallException
This cmdlet retrieves the exceptions from the firewall policy on the specified hosts.
This cmdlet activates or deactivates host firewall exceptions.
VMHostFirmware
This cmdlet retrieves hosts firmware information.
This cmdlet configures hosts firmware settings.
VMHostHardware
This cmdlet retrieves ESXi host hardware and firmware information.
VMHostHba
This cmdlet retrieves information about the available HBAs (Host Bus Adapter).
This cmdlet configures the CHAP properties of the specified iSCSI HBAs.
VMHostModule
This cmdlet retrieves the option strings of the specified host modules.
This cmdlet overrides the host module options with the given ones.
VMHostNetwork
THis cmdlet retrieves the host networks on a vCenter Server system.
This cmdlet updates the specified virtual network.
VMHostNetworkAdapter
This cmdlet retrieves the host network adapters on a vCenter Server system.
This cmdlet configures the specified host network adapter.
This cmdlet removes the specified host network adapters.
This cmdlet creates a new HostVirtualNIC (Service Console or VMKernel) on the specified host.
VMHostNetworkStack
This cmdlet retrieves the host network stacks on a vCenter Server system.
This cmdlet modifies the specified host network stack.
VMHostNtpServer
This cmdlet retrieves the NTP servers on the specified hosts.
This cmdlet adds the specified NTP servers to the NTP server list of the specified hosts.
This cmdlet removes the specified NTP servers from the NTP server list of the specified hosts.
VMHostPatch
This cmdlet retrieves information about the host patches installed on the specified hosts. This cmdlet is deprecated and will not return any results for ESX hosts version 5.0 and later. Use (Get-ESXCli).software.vib.list() as an alternative.
This cmdlet updates the specified hosts.
VMHostPciDevice
This cmdlet retrieves the PCI devices on the specified hosts.
VMHostProfile
This cmdlet retrieves the available host profiles.
This cmdlet exports the specified host profile to a file.
This cmdlet imports a host profile from a file. The file path must be accessible from the VMware PowerCLI client side.
This cmdlet applies a host profile to the specified host or cluster.
This cmdlet modifies the specified host profile.
This cmdlet removes the specified host profiles.
This cmdlet creates a new host profile based on a reference host.
VMHostProfileCompliance
This cmdlet tests hosts for profile compliance.
VMHostProfileImageCacheConfiguration
Retrieves an image cache configuration for the given host profile.
This cmdlet modifies image cache configuration for given host profile.
VMHostProfileRequiredInput
This cmdlet performs a check whether the available information is sufficient to apply a host profile.
VMHostProfileStorageDeviceConfiguration
Retrieves the storage device configuration for the given host profile.
This cmdlet modifies the storage device configuration for the given host profile.
VMHostProfileUserConfiguration
This cmdlet retrieves the user password configuration for the given host profile.
This cmdlet modifies the user password configuration for the specified account within a host profile.
VMHostProfileVmPortGroupConfiguration
Retrieves the virtual machine port group configuration for the given host profile.
This cmdlet modifies the virtual machine port group configuration for the given host profile.
Removes the given virtual machine port group configuration from the host profile.
This cmdlet creates a new virtual machine port group configuration.
VMHostRoute
This cmdlet retrieves the routes from the routing table of the specified hosts.
This cmdlet modifies a route in the host routing table.
This cmdlet removes host routes.
This cmdlet creates a new route in the routing table of a host.
VMHostService
This cmdlet retrieves information about a host service.
This cmdlet restarts the specified host services.
This cmdlet modifies a host service.
This cmdlet starts the specified host services.
This cmdlet stops the specified host services.
VMHostSnmp
This cmdlet retrieves hosts SNMP configuration.
This cmdlet modifies the host SNMP configuration.
This cmdlet tests the host SNMP.
VMHostStartPolicy
This cmdlet retrieves the start policy of hosts.
This cmdlet modifies the host default start policy.
VMHostStorage
This cmdlet retrieves the host storages on a vCenter Server system.
This cmdlet configures a host storage.
VMHostSysLogServer
This cmdlet displays the remote syslog servers of the specified hosts.
This cmdlet configures the remote syslog server of the specified hosts.
