Edit

Share via

Set-NfsMappingStore

Module:
NFS Module

Modifies configuration settings for an identity mapping store.

Syntax

Default (Default) 

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.

Parameters

-ADDomainName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:domain

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ad, AdLookUp

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableLdapLookup

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ldap, LdapLookup

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableUNMLookup

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

Parameter properties

Type:Boolean
Default value:0
Supports wildcards:False
DontShow:False
Aliases:unm, UNMLookUp

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:

CimInstance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LdapNamingContext

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LdapContext

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

CimInstance