Edit

Share via

New-NfsMappedIdentity

  • Reference
Module:
NFS

Creates a new NFS mapped identity.

Syntax

New-NfsMappedIdentity
   [-MappingStore <MappingStoreType>]
   [-Server <String>]
   [-LdapNamingContext <String>]
   -UserName <String>
   [-Password <SecureString>]
   -UserIdentifier <Int32>
   -GroupIdentifier <Int32>
   [-PrimaryGroup <String>]
   [-SupplementaryGroups <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-NfsMappedIdentity
   [-MappingStore <MappingStoreType>]
   [-Server <String>]
   [-LdapNamingContext <String>]
   -GroupName <String>
   [-Password <SecureString>]
   -GroupIdentifier <Int32>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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.

For more information about NFS, see Network File System Overview. For more information about NFS account mapping, see NFS Account Mapping Guide and Identity Management for UNIX.

Examples

Example 1: Create a mapped identify for a UNIX user account and a Windows user account

PS C:\> New-NfsMappedIdentity -MappingStore "AD" -Server "Contoso" -UserName "JBrown" -UserIdentifier 500 -GroupIdentifier 41

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

PS C:\> New-NfsMappedIdentity -MappingStore "Ldap" -GroupName "Operators" -GroupIdentifier 501 -Server "LdapServer01:389" -NfsServer "NFSServer-012"

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

PS C:\> New-NfsMappedIdentity -MappingStore "AD" -Server "Contoso" -UserName "JCool" -UserIdentifier 500 -GroupIdentifier 501 -PrimaryGroup "Operators"

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupIdentifier

Specifies a group identifier of a user or group account.

Type:Int32
Aliases:GroupId, gid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-GroupName

Specifies a SAMAcccount name of a group account.

Type:String
Aliases:group
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Aliases:dn
Position:Named
Default value:DefaultNamingContext
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:MappingStoreType
Aliases:store
Accepted values:Ad, Ldap, Mapfiles
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Aliases:LdapServer, ADDomainName
Position:Named
Default value:Localhost:389
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SupplementaryGroups

Specifies a comma-separated list of group names to which the cmdlet adds a user account that the UserName parameter specifies.

Type:String
Aliases:sg
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserIdentifier

Specifies the user identifier that the cmdlet assigns to the user account that the UserName parameter specifies.

Type:Int32
Aliases:UserId, uid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-UserName

Specifies a SAMAcccount name of a user account.

Type:String
Aliases:user
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Nothing