Set-NfsMappingStore

Modifies configuration settings for an identity mapping store.

Syntax

Set-NfsMappingStore
   [-InputObject <CimInstance[]>]
   [-EnableUNMLookup <Boolean>]
   [-UNMServer <String>]
   [-EnableADLookup <Boolean>]
   [-ADDomainName <String>]
   [-EnableLdapLookup <Boolean>]
   [-LdapServer <String>]
   [-LdapNamingContext <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NfsMappingStore cmdlet modifies configuration settings for an identity mapping store that a Network File System (NFS) server uses.

You can enable only one mapping store. Valid values are: Active Directory domain, Lightweight Directory Access Protocol (LDAP) server, and User Name Mapping (UNM) server. The specified mapping store must be accessible from an NFS server.

Note that you cannot modify password lookup by using the Set-NfsMappingStore cmdlet. Password lookup is automatically enabled when passwd file is located in a folder in the <system volume>:\system32\drivers\ path. You can also enable password mapping to Active Directory, LDAP, or UNM.

Examples

Example 1: Enable an AD DS store

PS C:\> Set-NfsMappingStore -EnableADLookup $True -ADDomainName "Contoso.com"

This command enables an AD DS store on a local NFS server and sets the AD DS store mapping store to Contoso.com.

Example 2: Enable the default Active Directory Domain

PS C:\>Set-NfsMappingStore -EnableADLookup $True

This command enables the default AD DS store on a local NFS server and sets the default domain as the mapping store. The default domain refers to the domain to which this NFS server belongs.

Example 3: Enable LDAP Lookup

PS C:\>Set-NfsMappingStore -EnableLDAPLookup $True -LdapServer "Contoso-LDAP"

This command enables an LDAP mapping lookup on a local NFS server, and sets the LDAP mapping store to Contoso-LDAP.

Optional Parameters

-ADDomainName

Specifies the Active Directory domain name that an NFS server uses as an identity mapping store.

Type:String
Aliases:domain
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AsJob

Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish.

When you use the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session while the job finishes. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

The AsJob parameter resembles using the Invoke-Command cmdlet to run a Start-Job command remotely. However, with AsJob, the job is created on the local computer, even though the job runs on a remote computer, and the results of the remote job are automatically returned to the local computer.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

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

Sets Active Directory Domain Services (AD DS) as the mapping store on an NFS server. If EnableADLookup is enabled and ADDomainName is not explicitly configured, then the default domain (that is, the domain to which the NFS server is joined) is used as a mapping store.

Type:Boolean
Aliases:ad, AdLookUp
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableLdapLookup

Sets an LDAP server or an Active Directory Lightweight Directory Services (AD LDS) server as the mapping store on an NFS server.

Type:Boolean
Aliases:ldap, LdapLookup
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableUNMLookup

Sets a User Name Mapping (UNM) server as the mapping store on an NFS server.

Type:Boolean
Aliases:unm, UNMLookUp
Position:Named
Default value:0
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-LdapNamingContext

Specifies an LDAP naming context that an NFS server uses when it performs LDAP queries.

Type:String
Aliases:LdapContext
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LdapServer

Specifies an LDAP server name or AD LDS server name that stores identity mapping. This information is used to get identity mapping information when LDAP lookup is enabled by using the LdapLookup parameter.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object that represents the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UNMServer

Specifies a UNM server. When UNM lookup is enabled by using the EnableUNMLookup parameter, this information is used to get identity mapping information.

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

Outputs

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_NfsMappingStore