Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NfsMappedIdentity

Set-NfsMappedIdentity

microsoft.fileservices.powershell.nfs.dll

Synopsis

Modifies a mapped identity.

Syntax

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

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

Detailed 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).

Parameters

-GroupIdentifier <Int32>

Specifies the group identifier of a mapped identity.

Aliases

GroupId,gid

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-GroupName <String>

Specifies the SAMAccountName of a Windows group account.

Aliases

group

Required?

true

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 (directory partition) of an NFS identity mapping store. You can use this parameter to search for mapped identities in the specified naming context.

Aliases

dn

Required?

false

Position

named

Default value

DefaultNamingContext

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MappingStore <MappingStoreType>

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.

Aliases

store

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Server <String>

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.

Aliases

LdapServer,ADDomainName

Required?

false

Position

named

Default value

localhost:389

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-UserIdentifier <Int32>

Specifies a UID to assign to a user account that the UserName parameter specifies.

Aliases

UserId,uid

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-UserName <String>

Specifies the SAMAccountName of a user account.

Aliases

user

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Nothing

Notes

None

Examples

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

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.

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

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

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.

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

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

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.

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

Online Version
Get-NfsMappedIdentity
New-NfsMappedIdentity
Remove-NfsMappedIdentity
Resolve-NfsMappedIdentity
Test-NfsMappedIdentity
Get-NfsMappingStore
Install-NfsMappingStore
Set-NfsMappingStore
Test-NfsMappingStore