Set-NfsMappingStore
Set-NfsMappingStore
Modifies configuration settings for an identity mapping store.
Syntax
Parameter Set: InputObject (cdxml)
Set-NfsMappingStore [-ADDomainName <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-EnableADLookup <Boolean> ] [-EnableLdapLookup <Boolean> ] [-EnableUNMLookup <Boolean> ] [-InputObject <CimInstance[]> ] [-LdapNamingContext <String> ] [-LdapServer <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-UNMServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-ADDomainName<String>
Specifies the Active Directory domain name that an NFS server uses as an identity mapping store.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableADLookup<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableLdapLookup<Boolean>
Sets an LDAP server or an Active Directory Lightweight Directory Services (AD LDS) server as the mapping store on an NFS server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableUNMLookup<Boolean>
Sets a User Name Mapping (UNM) server as the mapping store on an NFS server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
0 |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-LdapNamingContext<String>
Specifies an LDAP naming context that an NFS server uses when it performs LDAP queries.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LdapServer<String>
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.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UNMServer<String>
Specifies a UNM server. When UNM lookup is enabled by using the EnableUNMLookup parameter, this information is used to get identity mapping information.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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.
- Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_NfsMappingStore
Examples
Example 1: Enable an AD DS store
This command enables an AD DS store on a local NFS server and sets the AD DS store mapping store to Contoso.com.
PS C:\> Set-NfsMappingStore -EnableADLookup $true -ADDomainName "Contoso.com"
Example 2: Enable the default Active Directory Domain
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.
PS C:\> Set-NfsMappingStore -EnableADLookup $true
Example 3: Enable LDAP Lookup
This command enables an LDAP mapping lookup on a local NFS server, and sets the LDAP mapping store to Contoso-LDAP.
PS C:\> Set-NfsMappingStore -EnableLDAPLookup $true –LdapServer "Contoso-LDAP"