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
 

New-NfsNetgroup

New-NfsNetgroup

microsoft.fileservices.powershell.nfs.dll

Synopsis

Creates a netgroup.

Syntax

New-NfsNetgroup [-NetGroupName] [-AddMember] [-LdapServer] [-LdapNamingContext] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The New-NfsNetgroup cmdlet creates a netgroup. It can also add members to the new netgroup. The netgroup provides access to shares that Network File System (NFS) server exports.

You can create a netgroup in Active Directory Domain Services (AD DS), on an Active Directory Lightweight Directory Services (AD LDS) server, or on Lightweight Directory Access Protocol (LDAP) servers. If you do not specify a netgroup store, New-NfsNetgroup creates a netgroup in the netgroup store that is configured on the local computer.

The cmdlet creates the netgroup as a relative distinguished name in an LDAP naming context (directory partition). For example, if the specified naming context is DN=netgroups,CN=Contoso,CN=com", the distinguished name of the netgroup Contoso-PrintServices is "DN= Contoso-PrintServices ,DN=netgroups,CN=Contoso,CN=com".

You can group NFS client computers logically into netgroups to easily manage mount permissions for all the computers that are in the group. Because netgroups are a server-side setting, New-NfsNetgroup is not available on client operating systems.

Parameters

-AddMember <String[]>

Specifies the host names or IP addresses of the client computers to add to a netgroup.

Aliases

add

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LdapNamingContext <String>

Specifies the LDAP naming context of the new netgroup store.

Aliases

dn

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LdapServer <String>

Specifies the LDAP server name of the new netgroup store. The LDAP server name can be a domain name, AD LDS server name, or other LDAP server name.

Aliases

ldap

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NetGroupName <String>

Specifies the name of a new netgroup.

Aliases

name,ngname

Required?

true

Position

1

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

Microsoft.FileServices.Powershell.Nfs.NetGroup

Notes

None

Examples

Example 1: Create a netgroup and add a member

This command creates a netgroup that is named Contoso-PrintServices and adds one member that is named Contoso-PS02.

PS C:\> New-NfsNetgroup -NetGroupName "Contoso-PrintServices -AddMember "Contoso-PS02" -LdapInstanceName "Contoso.com" -LdapNamingContext "CN=MappedIdentity,DC=Contoso,DC=com"

Example 2: Create a netgroup and add multiple members

This command creates a netgroup that is named AppServers and adds two members that are named Contoso-APPS-11 and Contoso-APPS-12.

PS C:\> New-NfsNetgroup -NetGroupName "AppServers" -AddMember "Contoso-APPS-11","Contoso-APPS-12" -LdapServer "Contoso.com" -LdapNamingContext "CN=netgroup,DC=Contoso,DC=com"

Online Version
Get-NfsNetgroup
Remove-NfsNetgroup
Set-NfsNetgroup