Get-NfsMappedIdentity
Get-NfsMappedIdentity
Gets an NFS mapped identity.
Syntax
Parameter Set: DefaultSettings
Get-NfsMappedIdentity [-MappingStore <MappingStoreType> {Ad | Ldap | Mapfiles} ] [ <CommonParameters>]
Parameter Set: AdAdlds
Get-NfsMappedIdentity -MappingStore <MappingStoreType> {Ad | Ldap | Mapfiles} [-LdapNamingContext <String> ] [-Server <String> ] [ <CommonParameters>]
Parameter Set: AllParameterSets
Get-NfsMappedIdentity -AccountType <AccountType> {User | Group} [-AccountName <String> ] [-GroupIdentifier <Int32> ] [-UserIdentifier <Int32> ] [ <CommonParameters>]
Parameter Set: MapFiles
Get-NfsMappedIdentity -MappingStore <MappingStoreType> {Ad | Ldap | Mapfiles} [-MapFilesPath <String> ] [ <CommonParameters>]
Detailed 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.
Parameters
-AccountName<String>
Specifies the SAMAccountName of the Windows user account or group account of a mapped identity.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AccountType<AccountType>
Specifies the Windows account type of a mapped identity. Supported values are User and Group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GroupIdentifier<Int32>
Specifies the group identifier of a user or group account.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LdapNamingContext<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
DefaultNamingContext |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MapFilesPath<String>
Specifies the path of the passwd and group map files from which the Get-NfsMappedIdentity cmdlet gets a mapped identity.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
%SystemRoot\System32\Drivers\etc\ |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MappingStore<MappingStoreType>
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. Valid values are: AD, LDAP, and MapFiles.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Server<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
localhost:389 |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserIdentifier<Int32>
Specifies the UID of the user account.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.FileServices.Management.Nfs.UserMappedIdentity, System.FileServices.Management.Nfs.GroupMappedIdentity
Examples
Example 1: Get a mapped identity for a user account by using a specified name
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.
PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "User" -AccountName "RPatel"
Example 2: Get all group account mapped identities from a specific store instance
This command gets all mapped identities in the Administrator group from a configured AD LDS or RFC 2307–compliant LDAP store instance.
PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "Group" –GroupName "Administrators"
Example 3: Get a mapped identity for a group account by using a specified Id
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.
PS C:\> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "Group" -GroupIdentifier "GID99"
Example 4: Get all user account mapped identities from a specific mapping store
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.
C:\PS> Get-NfsMappedIdentity -MappingStore "LDAP" -AccountType "User"
Example 5: Get all user account mapped identities from a mapping store that is specified in the NFS Server configuration settings
This command gets all user account mapped identities from a mapping store that is specified in the NFS server configuration settings.
PS C:\> Get-NfsMappedIdentity -AccountType "User"