Skip to content

Commit c87ea1e

Browse files
authored
Merge pull request MicrosoftDocs#3418 from kevinCefalu/quality/winserver2022/dfsn
Quality: PowerShell Summit MicrosoftDocsGH-3327
2 parents 939a223 + 586c335 commit c87ea1e

24 files changed

+1647
-1145
lines changed

docset/winserver2022-ps/dfsn/DFSN.md

+28-4
Original file line numberDiff line numberDiff line change
@@ -10,78 +10,102 @@ title: DFSN
1010
---
1111

1212
# DFSN Module
13+
1314
## Description
14-
This reference provides cmdlet descriptions and syntax for all DFS Namespace cmdlets.
15-
It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
15+
16+
This reference provides cmdlet descriptions and syntax for all DFS Namespace cmdlets. It lists the
17+
cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
1618

1719
## DFSN Cmdlets
20+
1821
### [Get-DfsnAccess](./Get-DfsnAccess.md)
22+
1923
Gets permissions for a DFS namespace folder.
2024

2125
### [Get-DfsnFolder](./Get-DfsnFolder.md)
26+
2227
Gets settings for a DFS namespace folder.
2328

2429
### [Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md)
30+
2531
Gets settings for targets of a DFS namespace folder.
2632

2733
### [Get-DfsnRoot](./Get-DfsnRoot.md)
34+
2835
Gets settings for DFS namespaces.
2936

3037
### [Get-DfsnRootTarget](./Get-DfsnRootTarget.md)
38+
3139
Gets settings for root targets of a DFS namespace.
3240

3341
### [Get-DfsnServerConfiguration](./Get-DfsnServerConfiguration.md)
42+
3443
Gets DFS namespace settings for a DFSN root server.
3544

3645
### [Grant-DfsnAccess](./Grant-DfsnAccess.md)
46+
3747
Grants permissions to users and groups to access a DFS namespace folder.
3848

3949
### [Move-DfsnFolder](./Move-DfsnFolder.md)
50+
4051
Moves or renames a DFS namespace folder.
4152

4253
### [New-DfsnFolder](./New-DfsnFolder.md)
54+
4355
Creates a folder in a DFS namespace.
4456

4557
### [New-DfsnFolderTarget](./New-DfsnFolderTarget.md)
58+
4659
Adds a target to a DFS namespace folder.
4760

4861
### [New-DfsnRoot](./New-DfsnRoot.md)
62+
4963
Creates a DFS namespace.
5064

5165
### [New-DfsnRootTarget](./New-DfsnRootTarget.md)
66+
5267
Adds a root target to a DFS namespace.
5368

5469
### [Remove-DfsnAccess](./Remove-DfsnAccess.md)
70+
5571
Removes users and groups from the ACL for a folder in a DFS namespace.
5672

5773
### [Remove-DfsnFolder](./Remove-DfsnFolder.md)
74+
5875
Removes a DFS namespace folder.
5976

6077
### [Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md)
78+
6179
Removes a target for a DFS namespace folder.
6280

6381
### [Remove-DfsnRoot](./Remove-DfsnRoot.md)
82+
6483
Removes a DFS namespace.
6584

6685
### [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md)
86+
6787
Removes a target for a DFS namespace root.
6888

6989
### [Revoke-DfsnAccess](./Revoke-DfsnAccess.md)
90+
7091
Revokes permissions for users to access and enumerate the contents of a DFS namespace folder.
7192

7293
### [Set-DfsnFolder](./Set-DfsnFolder.md)
94+
7395
Changes settings for a DFS namespace folder.
7496

7597
### [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md)
98+
7699
Changes settings for a target of a DFS namespace folder.
77100

78101
### [Set-DfsnRoot](./Set-DfsnRoot.md)
102+
79103
Changes settings for a DFS namespace.
80104

81105
### [Set-DfsnRootTarget](./Set-DfsnRootTarget.md)
106+
82107
Changes settings for a root target of a DFS namespace.
83108

84109
### [Set-DfsnServerConfiguration](./Set-DfsnServerConfiguration.md)
85-
Changes settings for a DFS namespace root server.
86-
87110

111+
Changes settings for a DFS namespace root server.

docset/winserver2022-ps/dfsn/Get-DfsnAccess.md

+43-24
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ title: Get-DfsnAccess
1111
# Get-DfsnAccess
1212

1313
## SYNOPSIS
14+
1415
Gets permissions for a DFS namespace folder.
1516

1617
## SYNTAX
@@ -21,34 +22,43 @@ Get-DfsnAccess [-Path] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <In
2122
```
2223

2324
## DESCRIPTION
24-
The **Get-DfsnAccess** cmdlet gets account names and access types for users and groups that have permissions for a Distributed File System (DFS) namespace folder.
25-
You can use the **Grant-DfsnAccess** cmdlet and the **Revoke-DfsnAccess** cmdlet to manage access for DFS namespace folders.
2625

27-
For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet.
26+
The **Get-DfsnAccess** cmdlet gets account names and access types for users and groups that have
27+
permissions for a Distributed File System (DFS) namespace folder. You can use the
28+
**Grant-DfsnAccess** cmdlet and the **Revoke-DfsnAccess** cmdlet to manage access for DFS namespace
29+
folders.
30+
31+
For more information about DFS namespaces, see
32+
[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet.
2833

2934
## EXAMPLES
3035

3136
### Example 1: Get permissions for a folder
32-
```
33-
PS C:\> Get-DfsnAccess -Path "\\Contoso\Software\Projects"
37+
38+
```powershell
39+
Get-DfsnAccess -Path "\\Contoso\Software\Projects"
3440
```
3541

36-
This command gets permissions for a DFS namespace folder that has the path \\\\Contoso\Software\Projects.
42+
This command gets permissions for a DFS namespace folder that has the path
43+
`\\Contoso\Software\Projects`.
3744

3845
## PARAMETERS
3946

4047
### -AsJob
41-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4248

43-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
44-
You can continue to work in the session while the job completes.
45-
To manage the job, use the `*-Job` cmdlets.
46-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
49+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
50+
complete.
51+
52+
The cmdlet immediately returns an object that represents the job and then displays the command
53+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
54+
`*-Job` cmdlets. To get the job results, use the
55+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
4756

48-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
57+
For more information about Windows PowerShell background jobs, see
58+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
4959

5060
```yaml
51-
Type: SwitchParameter
61+
Type: System.Management.Automation.SwitchParameter
5262
Parameter Sets: (All)
5363
Aliases:
5464

@@ -60,12 +70,14 @@ Accept wildcard characters: False
6070
```
6171
6272
### -CimSession
63-
Runs the cmdlet in a remote session or on a remote computer.
64-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
65-
The default is the current session on the local computer.
73+
74+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
75+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
76+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
77+
current session on the local computer.
6678
6779
```yaml
68-
Type: CimSession[]
80+
Type: Microsoft.Management.Infrastructure.CimSession[]
6981
Parameter Sets: (All)
7082
Aliases: Session
7183

@@ -77,12 +89,13 @@ Accept wildcard characters: False
7789
```
7890
7991
### -Path
92+
8093
Specifies a path for a DFS namespace folder.
8194
This cmdlet gets permissions for the folder specified.
8295
Provide a complete path for a folder, not a partial or relative path.
8396
8497
```yaml
85-
Type: String
98+
Type: System.String
8699
Parameter Sets: (All)
87100
Aliases: DfsPath, FolderPath, NamespacePath
88101

@@ -94,12 +107,15 @@ Accept wildcard characters: False
94107
```
95108
96109
### -ThrottleLimit
97-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
98-
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.
99-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
110+
111+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
112+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
113+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
114+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
115+
computer.
100116

101117
```yaml
102-
Type: Int32
118+
Type: System.Int32
103119
Parameter Sets: (All)
104120
Aliases:
105121
@@ -111,7 +127,11 @@ Accept wildcard characters: False
111127
```
112128

113129
### CommonParameters
114-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
130+
131+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`,
132+
`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`,
133+
`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see
134+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
115135

116136
## INPUTS
117137

@@ -130,4 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
130150
[Remove-DfsnAccess](./Remove-DfsnAccess.md)
131151

132152
[Revoke-DfsnAccess](./Revoke-DfsnAccess.md)
133-

docset/winserver2022-ps/dfsn/Get-DfsnFolder.md

+48-31
Original file line numberDiff line numberDiff line change
@@ -21,41 +21,49 @@ Get-DfsnFolder [-Path] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <In
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-DfsnFolder** cmdlet gets configuration settings for a Distributed File System (DFS) namespace folder.
25-
Specify a folder by using its path.
2624

27-
For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet.
25+
The **Get-DfsnFolder** cmdlet gets configuration settings for a Distributed File System (DFS)
26+
namespace folder. Specify a folder by using its path.
27+
28+
For more information about DFS namespaces, see
29+
[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet.
2830

2931
## EXAMPLES
3032

3133
### Example 1: Get settings for a specified folder
32-
```
33-
PS C:\> Get-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware"
34+
35+
```powershell
36+
Get-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware'
3437
```
3538

36-
This command displays settings for the \\\\Contoso\AccountingResources\LegacySoftware folder.
39+
This command displays settings for the `\\Contoso\AccountingResources\LegacySoftware` folder.
3740

3841
### Example 2: Get settings for all folders in a DFS namespace
39-
```
40-
PS C:\> Get-DfsnFolder -Path "\\Contoso\AccountingResources\*"
42+
43+
```powershell
44+
Get-DfsnFolder -Path '\\Contoso\AccountingResources\*'
4145
```
4246

43-
The command uses the wildcard to get settings for all the folders in the \\\\Contoso\AccountingResources DFS namespace.
47+
The command uses the wildcard to get settings for all the folders in the
48+
`\\Contoso\AccountingResources` DFS namespace.
4449

4550
## PARAMETERS
4651

4752
### -AsJob
48-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4953

50-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
51-
You can continue to work in the session while the job completes.
52-
To manage the job, use the `*-Job` cmdlets.
53-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
54+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
55+
complete.
56+
57+
The cmdlet immediately returns an object that represents the job and then displays the command
58+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
59+
`*-Job` cmdlets. To get the job results, use the
60+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
5461

55-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
62+
For more information about Windows PowerShell background jobs, see
63+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5664

5765
```yaml
58-
Type: SwitchParameter
66+
Type: System.Management.Automation.SwitchParameter
5967
Parameter Sets: (All)
6068
Aliases:
6169

@@ -67,12 +75,14 @@ Accept wildcard characters: False
6775
```
6876
6977
### -CimSession
70-
Runs the cmdlet in a remote session or on a remote computer.
71-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
72-
The default is the current session on the local computer.
78+
79+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
80+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
81+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
82+
current session on the local computer.
7383
7484
```yaml
75-
Type: CimSession[]
85+
Type: Microsoft.Management.Infrastructure.CimSession[]
7686
Parameter Sets: (All)
7787
Aliases: Session
7888

@@ -84,14 +94,15 @@ Accept wildcard characters: False
8494
```
8595
8696
### -Path
87-
Specifies a path for the folder.
88-
This cmdlet gets configuration settings for the DFS namespace folder that has the path specified.
8997
90-
You can use DFS namespace with the wildcard character to get settings for all the folders in the namespace.
91-
See the Examples section.
98+
Specifies a path for the folder. This cmdlet gets configuration settings for the DFS namespace
99+
folder that has the path specified.
100+
101+
You can use DFS namespace with the wildcard character to get settings for all the folders in the
102+
namespace. See the Examples section.
92103
93104
```yaml
94-
Type: String
105+
Type: System.String
95106
Parameter Sets: (All)
96107
Aliases: DfsPath, FolderPath, NamespacePath
97108

@@ -103,12 +114,15 @@ Accept wildcard characters: True
103114
```
104115
105116
### -ThrottleLimit
106-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
107-
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.
108-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
117+
118+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
119+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
120+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
121+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
122+
computer.
109123

110124
```yaml
111-
Type: Int32
125+
Type: System.Int32
112126
Parameter Sets: (All)
113127
Aliases:
114128
@@ -120,7 +134,11 @@ Accept wildcard characters: False
120134
```
121135

122136
### CommonParameters
123-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
137+
138+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`,
139+
`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`,
140+
`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see
141+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
124142

125143
## INPUTS
126144

@@ -141,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
141159
[Remove-DfsnFolder](./Remove-DfsnFolder.md)
142160

143161
[Set-DfsnFolder](./Set-DfsnFolder.md)
144-

0 commit comments

Comments
 (0)