Skip to content

Commit 65ff0d9

Browse files
committed
Applied feedback
1 parent 9f85ab1 commit 65ff0d9

File tree

4 files changed

+73
-65
lines changed

4 files changed

+73
-65
lines changed

docset/winserver2025-ps/smbshare/Get-SmbShare.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Name ScopeName Path
5959
VMS1 * I:\VMS
6060
```
6161

62-
This command retrieves information about the SMB share named 'VMS1' on the local computer.
62+
This command retrieves information about the SMB share named `VMS1` on the local computer.
6363

6464
### Example 3: Display information about the SMB shares on a remote computer
6565

@@ -79,7 +79,7 @@ VHD and ISO * D:\\data\VHD and ISO ae-dfsr-sr-01
7979
8080
```
8181

82-
This command displays the information about the SMB shares on the remote computer NEDFS1.
82+
This command displays the information about the SMB shares on the remote computer `NEDFS1`.
8383

8484
### Example 4: Display all properties about a specific SMB share on the local computer in a list
8585

@@ -113,7 +113,7 @@ CimInstanceProperties : {AvailabilityType, CachingMode, CATimeout, ConcurrentUse
113113
CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties
114114
```
115115

116-
This command displays all of the information about the SMB share named 'VMS1' on the local computer
116+
This command displays all of the information about the SMB share named `VMS1` on the local computer
117117
as a formatted list.
118118

119119
### Example 5: Get shares on the local failover cluster computer that have scale out availability
@@ -142,7 +142,7 @@ VMS2 Contoso-FS J:\VMS
142142
```
143143

144144
This command retrieves the SMB shares on the Windows Server failover cluster that are connected to
145-
the clustered file server resource named Contoso-FS.
145+
the clustered file server resource named `Contoso-FS`.
146146

147147
## PARAMETERS
148148

@@ -223,7 +223,7 @@ Accept wildcard characters: False
223223
224224
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
225225
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
226-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
226+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
227227
current session on the local computer.
228228
229229
```yaml

docset/winserver2025-ps/smbshare/New-SmbShare.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To delete a share that was created by this cmdlet, use the `Remove-SmbShare` cmd
4242

4343
```powershell
4444
$Parameters = @{
45-
Name = 'Public'
45+
Name = 'VMSFiles'
4646
Path = 'D:\Public'
4747
FullAccess = 'Contoso\Administrator', 'Contoso\Contoso-HV1$'
4848
}
@@ -162,7 +162,7 @@ Accept wildcard characters: False
162162

163163
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
164164
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
165-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
165+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
166166
current session on the local computer.
167167

168168
```yaml
@@ -211,22 +211,6 @@ Accept pipeline input: False
211211
Accept wildcard characters: False
212212
```
213213

214-
### -Confirm
215-
216-
Prompts you for confirmation before running the cmdlet.
217-
218-
```yaml
219-
Type: SwitchParameter
220-
Parameter Sets: (All)
221-
Aliases: cf
222-
223-
Required: False
224-
Position: Named
225-
Default value: False
226-
Accept pipeline input: False
227-
Accept wildcard characters: False
228-
```
229-
230214
### -ContinuouslyAvailable
231215

232216
Indicates that the share is continuously available.
@@ -330,9 +314,9 @@ Accept wildcard characters: False
330314
Specifies SMB leasing and oplock behaviors for application compatibility. The acceptable values for
331315
this parameter are:
332316

333-
- `Full:` Use default lease and oplock behaviors from SMB3.
334-
- `Shared:` Grant read-caching lease but not write or handle-caching.
335-
- `None:` No oplocks or leases, behave like SMB1 (not recommended).
317+
- `Full`: Use default lease and oplock behaviors from SMB3.
318+
- `Shared`: Grant read-caching lease but not write or handle-caching.
319+
- `None`: No oplocks or leases, behave like SMB1 (not recommended).
336320

337321
```yaml
338322
Type: LeasingMode
@@ -488,6 +472,22 @@ Accept pipeline input: False
488472
Accept wildcard characters: False
489473
```
490474

475+
### -Confirm
476+
477+
Prompts you for confirmation before running the cmdlet.
478+
479+
```yaml
480+
Type: SwitchParameter
481+
Parameter Sets: (All)
482+
Aliases: cf
483+
484+
Required: False
485+
Position: Named
486+
Default value: False
487+
Accept pipeline input: False
488+
Accept wildcard characters: False
489+
```
490+
491491
### -WhatIf
492492

493493
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

docset/winserver2025-ps/smbshare/Remove-SmbShare.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,16 @@ Deletes the specified SMB shares.
1515

1616
## SYNTAX
1717

18+
### Query
19+
1820
```
1921
Remove-SmbShare [-Name] <String[]> [[-ScopeName] <String[]>] [-SmbInstance <SmbInstance>] [-Force]
2022
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
2123
[<CommonParameters>]
2224
```
2325

26+
### InputObject
27+
2428
```
2529
Remove-SmbShare -InputObject <CimInstance[]> [-Force] [-CimSession <CimSession[]>]
2630
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -32,7 +36,7 @@ The `Remove-SmbShare` cmdlet deletes one or more Server Message Block (SMB) shar
3236

3337
Removing an SMB share forcibly disconnects all of the existing connections to the share. Use this
3438
cmdlet with caution. Clients that are forcibly disconnected from a share aren't able to flush
35-
locally cached data before they are disconnected. This may cause data loss. Use the Get-SmbSession
39+
locally cached data before they are disconnected. This may cause data loss. Use the `Get-SmbSession`
3640
cmdlet to determine whether users are connected to a share.
3741

3842
## EXAMPLES
@@ -49,15 +53,15 @@ Performing operation `Remove-Share` on Target 'Contoso-FS,Data'.
4953
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
5054
```
5155

52-
This command deletes the SMB share named **Data**.
56+
This command deletes the SMB share named `Data`.
5357

5458
### Example 2: Delete a Windows Server failover cluster file server resource SMB share without confirmation
5559

5660
```powershell
5761
Remove-SmbShare -Name "VMFiles" -ScopeName "Contoso-SO" -Force
5862
```
5963

60-
This command deletes the SMB share named VMFiles on the `Contoso-SO` file server resource without
64+
This command deletes the SMB share named `VMFiles` on the `Contoso-SO` file server resource without
6165
user confirmation.
6266

6367
## PARAMETERS
@@ -83,7 +87,7 @@ Accept wildcard characters: False
8387
8488
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
8589
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
86-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
90+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
8791
current session on the local computer.
8892
8993
```yaml
@@ -98,22 +102,6 @@ Accept pipeline input: False
98102
Accept wildcard characters: False
99103
```
100104
101-
### -Confirm
102-
103-
Prompts you for confirmation before running the cmdlet.
104-
105-
```yaml
106-
Type: SwitchParameter
107-
Parameter Sets: (All)
108-
Aliases: cf
109-
110-
Required: False
111-
Position: Named
112-
Default value: None
113-
Accept pipeline input: False
114-
Accept wildcard characters: False
115-
```
116-
117105
### -Force
118106
119107
Forces the command to run without asking for user confirmation.
@@ -136,7 +124,7 @@ Specifies the input object that's used in a pipeline command.
136124
137125
```yaml
138126
Type: CimInstance[]
139-
Parameter Sets: InputObject (cdxml)
127+
Parameter Sets: InputObject
140128
Aliases:
141129

142130
Required: True
@@ -234,6 +222,22 @@ Accept pipeline input: False
234222
Accept wildcard characters: False
235223
```
236224

225+
### -Confirm
226+
227+
Prompts you for confirmation before running the cmdlet.
228+
229+
```yaml
230+
Type: SwitchParameter
231+
Parameter Sets: (All)
232+
Aliases: cf
233+
234+
Required: False
235+
Position: Named
236+
Default value: None
237+
Accept pipeline input: False
238+
Accept wildcard characters: False
239+
```
240+
237241
### -WhatIf
238242

239243
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

docset/winserver2025-ps/smbshare/Set-SmbShare.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Modifies the properties of the SMB share.
1515

1616
## SYNTAX
1717

18+
### Query
19+
1820
```
1921
Set-SmbShare [-Name] <String[]> [[-ScopeName] <String[]>] [-SmbInstance <SmbInstance>]
2022
[-Description <String>] [-ConcurrentUserLimit <UInt32>] [-CATimeout <UInt32>]
@@ -26,6 +28,8 @@ Set-SmbShare [-Name] <String[]> [[-ScopeName] <String[]>] [-SmbInstance <SmbInst
2628
[-Confirm] [<CommonParameters>]
2729
```
2830

31+
### InputObject
32+
2933
```
3034
Set-SmbShare -InputObject <CimInstance[]> [-Description <String>] [-ConcurrentUserLimit <UInt32>]
3135
[-CATimeout <UInt32>] [-ContinuouslyAvailable <Boolean>]
@@ -126,7 +130,7 @@ Accept wildcard characters: False
126130
127131
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
128132
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
129-
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
133+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
130134
current session on the local computer.
131135
132136
```yaml
@@ -175,22 +179,6 @@ Accept pipeline input: True (ByPropertyName)
175179
Accept wildcard characters: False
176180
```
177181
178-
### -Confirm
179-
180-
Prompts you for confirmation before running the cmdlet.
181-
182-
```yaml
183-
Type: SwitchParameter
184-
Parameter Sets: (All)
185-
Aliases: cf
186-
187-
Required: False
188-
Position: Named
189-
Default value: None
190-
Accept pipeline input: False
191-
Accept wildcard characters: False
192-
```
193-
194182
### -ContinuouslyAvailable
195183
196184
Indicates whether the share is continuously available.
@@ -309,7 +297,7 @@ Specifies the input object that's used in a pipeline command.
309297

310298
```yaml
311299
Type: CimInstance[]
312-
Parameter Sets: InputObject (cdxml)
300+
Parameter Sets: InputObject
313301
Aliases:
314302
315303
Required: True
@@ -508,6 +496,22 @@ Accept pipeline input: False
508496
Accept wildcard characters: False
509497
```
510498

499+
### -Confirm
500+
501+
Prompts you for confirmation before running the cmdlet.
502+
503+
```yaml
504+
Type: SwitchParameter
505+
Parameter Sets: (All)
506+
Aliases: cf
507+
508+
Required: False
509+
Position: Named
510+
Default value: None
511+
Accept pipeline input: False
512+
Accept wildcard characters: False
513+
```
514+
511515
### -WhatIf
512516

513517
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

0 commit comments

Comments
 (0)