Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NfsMappedIdentity

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Gets an NFS mapped identity.

SYNTAX

DefaultSettings (Default)

Get-NfsMappedIdentity [-MappingStore <MappingStoreType>] [-UserIdentifier <Int32>] [-GroupIdentifier <Int32>]
 [-AccountName <String>] -AccountType <AccountType> [<CommonParameters>]

AdAdlds

Get-NfsMappedIdentity -MappingStore <MappingStoreType> [-Server <String>] [-LdapNamingContext <String>]
 [-UserIdentifier <Int32>] [-GroupIdentifier <Int32>] [-AccountName <String>] -AccountType <AccountType>
 [<CommonParameters>]

MapFiles

Get-NfsMappedIdentity -MappingStore <MappingStoreType> [-MapFilesPath <String>] [-UserIdentifier <Int32>]
 [-GroupIdentifier <Int32>] [-AccountName <String>] -AccountType <AccountType> [<CommonParameters>]

DESCRIPTION

The Get-NfsMappedIdentity cmdlet gets a Network File System (NFS) mapped identity.

A mapped identity associates a Windows user account or group account to a UNIX user account or group account. A user ID (UID) or group ID (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. For more information about NFS account mapping, see NFS Account Mapping Guide and Identity Management for UNIX.

EXAMPLES

Example 1: Get a mapped identity for a user account by using a specified name

PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "User" -AccountName "RPatel"

This command gets all user account mapped identities from a configured AD LDS or RFC 2307-compliant LDAP store instance. In this example, the command returns PrimaryGroup and SupplementaryGroups only when the configured mapping store is MapFiles.

Example 2: Get all group account mapped identities from a specific store instance

PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "Group" -GroupName "Administrators"

This command gets all mapped identities in the Administrator group from a configured AD LDS or RFC 2307-compliant LDAP store instance.

Example 3: Get a mapped identity for a group account by using a specified Id

PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "Group" -GroupIdentifier "GID99"

This command gets a mapped identity for the group account that has the GID 99, from a configured AD LDS or RFC 2307-compliant LDAP store instance.

Example 4: Get all user account mapped identities from a specific mapping store

PS C:\>Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "User"

This command gets all user account mapped identities from a configured AD LDS or RFC 2307-compliant LDAP store instance. PrimaryGroup and SupplementaryGroups are returned only when the configured mapping store is MapFiles.

Example 5: Get all user account mapped identities from a mapping store that is specified in the NFS Server configuration settings

PS C:\>Get-NfsMappedIdentity -AccountType "User"

This command gets all user account mapped identities from a mapping store that is specified in the NFS server configuration settings.

PARAMETERS

-AccountName

Specifies the SAMAccountName of the Windows user account or group account of a mapped identity.

Type: String
Parameter Sets: (All)
Aliases: aname, an

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AccountType

Specifies the Windows account type of a mapped identity. Valid values are User and Group.

Type: AccountType
Parameter Sets: (All)
Aliases: atype, at
Accepted values: User, Group

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupIdentifier

Specifies the group identifier of a user or group account.

Type: Int32
Parameter Sets: (All)
Aliases: GroupId, gid

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LdapNamingContext

Specifies the Lightweight Directory Access Protocol (LDAP) naming context of the NFS identity mapping store. You can use this parameter to search for mapped identities in the specified naming context.

Type: String
Parameter Sets: AdAdlds
Aliases: dn

Required: False
Position: Named
Default value: DefaultNamingContext
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MapFilesPath

Specifies the path of the passwd and group map files from which the Get-NfsMappedIdentity cmdlet gets a mapped identity.

Type: String
Parameter Sets: MapFiles
Aliases: 

Required: False
Position: Named
Default value: %SystemRoot\System32\Drivers\etc\
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MappingStore

Specifies the type of identity mapping store from which the Get-NfsMappedIdentity cmdlet gets a mapped identity. When this parameter is not specified, the cmdlet gets the store configuration settings from the NFS server configuration where this command is run configuration where this command is run.

The acceptable values for this parameter are:

  • AD
  • LDAP
  • MapFiles
Type: MappingStoreType
Parameter Sets: DefaultSettings
Aliases: store
Accepted values: Ad, Ldap, Mapfiles

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: MappingStoreType
Parameter Sets: AdAdlds, MapFiles
Aliases: store
Accepted values: Ad, Ldap, Mapfiles

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Server

Specifies the LDAP instance name of the store that NFS server uses. This can be an Active Directory 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
Parameter Sets: AdAdlds
Aliases: LdapServer, ADDomainName

Required: False
Position: Named
Default value: Localhost:389
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserIdentifier

Specifies the UID of the user account.

Type: Int32
Parameter Sets: (All)
Aliases: UserId, uid

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.FileServices.Management.Nfs.UserMappedIdentity, System.FileServices.Management.Nfs.GroupMappedIdentity

NOTES

RFC-2307

Get-NfsMappedIdentity

Get-NfsMappingStore

Install-NfsMappingStore

New-NfsMappedIdentity

Remove-NfsMappedIdentity

Resolve-NfsMappedIdentity

Set-NfsMappedIdentity

Set-NfsMappingStore

Test-NfsMappedIdentity

Test-NfsMappingStore

© 2017 Microsoft