< Back

New-NfsUser

Sun Jan 19, 2020 7:17 pm

NAME New-NfsUser



SYNOPSIS

This cmdlet creates an NFS user account on the specified virtual machine host.





SYNTAX

New-NfsUser [[-Username] <String>] [[-Password] <SecureString>] [-Credential <PSCredential>] [-Force] [-Server

<VIServer[]>] -VMHost <VMHost> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

This cmdlet creates an NFS user account on the specified virtual machine host. The credentials of the newly

created NFS user account are used by NFS v4.1 for Kerberos authentication. If an NFS user account already exists

on the virtual machine host, this cmdlet overwrites that NFS user account. The virtual machine host must be part

of an Active Directory domain for the cmdlet to run successfully.





PARAMETERS

-Credential <PSCredential>

Specifies a PSCredential object for Kerberos authentication.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

By default, the cmdlet fails to create an NFS user account if an NFS user account with the same user name

already exists on the virtual machine host. If Force is specified, the cmdlet overwrites the existing NFS user

account.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Password <SecureString>

Specifies password for authentication. This parameter accepts both secure and plain strings.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Server <VIServer[]>

Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this

parameter, the command runs on the default servers. For more information about default servers, see the

description of Connect-VIServer.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Username <String>

Specifies the NFS user name to be used for Kerberos authentication.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VMHost <VMHost>

Specifies the virtual machine host on which you want to add the NFS user account.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-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

The newly created NfsUser object







NOTES









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



New-NfsUser -VMHost $vmhost -Username "user1" -Password "password1"



Creates the "user1" NFS user account on the $vmhost virtual machine host and sets the password to "password1".

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



New-NfsUser -VMHost $vmhost -Credential $myCredentialsObject



Creates an NFS user account by using a credential object.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... sUser.html

Get-NfsUser

Remove-NfsUser

Set-NfsUser