The New-NfsMappedIdentity cmdlet creates a new Network File System (NFS) mapped identity between a UNIX user account or group account and a Windows user account or group account.
If a specified user account or group account does not exist, the New-NfsMappedIdentity cmdlet can create the account, set its user ID (UID) and group ID (GID) attributes, and update user membership in the group.
A mapped identity associates a Windows user account or group account to a UNIX user account or group account.
A UID or GID identifies a UNIX account namespace.
These elements are associated with the corresponding elements of a Windows account namespace: a user name or a group name.
By using a mapped identity, a user who is logged on to a UNIX domain can access shared resources in a Windows domain without having to log on to the Windows domain.
This command creates a mapped identity for a UNIX user that has a UID of 500, and maps it to the Windows account name Contoso\JBrown in a Windows group that has the group identifier of 41.
The command stores the mapped identity in the configured Active Directory domain of the local computer.
If the user account does not already exist, the command creates it.
Example 2: Create a mapped identity for a UNIX group account and a Windows group account
This command creates a mapped identity for a UNIX group that has a group identifier of 501 and maps it to the Windows group account that is named Operators.
The mapped identity is stored in the configured LDAP store on the computer that is named LdapServer01, that the NFS server NFSServer-012 uses.
The command also creates a local group account named Operators on the NFS server NFSServer-012 if it does not already exist.
Example 3: Create an identity mapping and create the user account and group account if they do not exist
This command creates a mapped identity for a UNIX user whose UID is 500 and maps it to the Windows account named Contoso\JCool.
The mapped identity is stored in the Active Directory domain named Contoso.
If the user account Contoso\JCool does not exist, the command creates the user account.
If the group account Operators does not exist, the command creates the group, assigns GID 501 to the group, and adds the user account Contoso\JCool to the group.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-GroupIdentifier
Specifies a group identifier of a user or group account.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
GroupId, gid
Parameter sets
(All)
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-GroupName
Specifies a SAMAcccount name of a group account.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
group
Parameter sets
Group
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-LdapNamingContext
Specifies the Lightweight Directory Access Protocol (LDAP) naming context (directory partition) of the identity mapping store that NFS uses.
You can use this parameter to search for mapped identities in the specified naming context.
Parameter properties
Type:
String
Default value:
DefaultNamingContext
Supports wildcards:
False
DontShow:
False
Aliases:
dn
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-MappingStore
Specifies the type of identity mapping store in which the New-NfsMappedIdentity cmdlet creates a mapped identity.
When the MappingStore is not specified, the New-NfsMappedIdentity cmdlet gets the store configuration settings from an NFS server.
Valid values are AD and LDAP.
Parameter properties
Type:
MappingStoreType
Default value:
None
Accepted values:
Ad, Ldap, Mapfiles
Supports wildcards:
False
DontShow:
False
Aliases:
store
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Password
Specifies a password for a user account that the New-NfsMappedIdentity cmdlet creates.
If no password is specified, the cmdlet disables the new user account until a password is set.
Parameter properties
Type:
SecureString
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-PrimaryGroup
Specifies the name of the group account that the cmdlet creates if no existing group account has the specified group identifier.
In this case, the GroupIdentifier parameter assigns a GID to the group account.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
User
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-Server
Specifies the LDAP instance name of the store that an NFS server uses.
This can be a domain name, Active Directory Lightweight Directory Services (AD LDS) server name, or LDAP server name.
When this parameter is not specified, the cmdlet tries to connect to either the LDAP store on the local computer at port 389 when MappingStore is LDAP, or the Active Directory domain of the computer when MappingStore is Active Directory.
Parameter properties
Type:
String
Default value:
Localhost:389
Supports wildcards:
False
DontShow:
False
Aliases:
LdapServer, ADDomainName
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-SupplementaryGroups
Specifies a comma-separated list of group names to which the cmdlet adds a user account that the UserName parameter specifies.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
sg
Parameter sets
User
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-UserIdentifier
Specifies the user identifier that the cmdlet assigns to the user account that the UserName parameter specifies.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
UserId, uid
Parameter sets
User
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-UserName
Specifies a SAMAcccount name of a user account.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
user
Parameter sets
User
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.