Edit

Share via

Set-NfsMappedIdentity

Module:
NFS Module

Modifies a mapped identity.

Syntax

User (Default) 

Set-NfsMappedIdentity
    -UserName <String>
    [-MappingStore <MappingStoreType>]
    [-Server <String>]
    [-LdapNamingContext <String>]
    [-UserIdentifier <Int32>]
    [-GroupIdentifier <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Group 

Set-NfsMappedIdentity
    -GroupName <String>
    -GroupIdentifier <Int32>
    [-MappingStore <MappingStoreType>]
    [-Server <String>]
    [-LdapNamingContext <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-NfsMappedIdentity cmdlet modifies a mapped identity that is stored in the Network File System (NFS) server mapping store. The cmdlet also updates the group membership of the Windows user account to match its assigned group identifier (GID).

Examples

Example 1: Modify a mapped identity that is stored in an AD LDS instance

PS C:\> Set-NfsMappedIdentity -MappingStore "LDAP" -GroupName "Administrators" -GroupIdentifier 600

This command modifies a mapped identity that is stored in a configured AD LDS instance and that corresponds to the Windows group account Administrators. The command resets the associated group identifier to 600.

Example 2: Modify a mapped identity that is stored in an Active Directory domain

PS C:\> Set-NfsMappedIdentity -Store "AD" -Server "Contoso"-UserName "JCool" -UserIdentifier 501 -GroupIdentifier 600

This command modifies a mapped identity that is stored in a specified Active Directory domain and that corresponds to the user account JCool. The command sets the user identifier to 501 and the group identifier to 600, and it updates the group membership of the user account JCool to make it a member of a group account that has GID 600.

Example 3: Modify a mapped identity that is stored in a configured LDAP store

PS C:\> Set-NfsMappedIdentity -Store "LDAP" -UserName "JCool" -UserIdentifier 501 -GroupIdentifier 600 -Server "MyLdapServer:389" -LdapNamingContext "CN=NFS,DC=NFS"

This command modifies a mapped identity that is stored in the LDAP store on a specified server that is named MyLdapServer and that corresponds to the user account Contoso\JCool. It sets the user identifier to 501 and the group identifier to 600. The command also adds the user account JCool to GID 600.

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 the group identifier of a mapped identity.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupId, gid

Parameter sets

User
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-GroupName

Specifies the SAMAccountName of a Windows 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 an NFS identity mapping store. 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 Set-NfsMappedIdentity cmdlet updates a mapped identity. When this parameter is not specified, the Set-NfsMappedIdentity cmdlet gets the store configuration settings from the 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

-Server

Specifies the LDAP server name of a store that 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

-UserIdentifier

Specifies a UID to assign to a 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:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UserName

Specifies the SAMAccountName 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.

Outputs

Nothing