Skip to content

Commit 9175713

Browse files
committed
Applied feedback
1 parent 65ff0d9 commit 9175713

File tree

4 files changed

+27
-26
lines changed

4 files changed

+27
-26
lines changed

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ being displayed by the computer.
3737
### Example 1: Get SMB shares on a local computer
3838

3939
```powershell
40-
PS C:\\>Get-SMBShare
40+
Get-SMBShare
4141
Name ScopeName Path Description
4242
---- --------- ---- -----------
4343
ADMIN$ * C:\\Windows Remote Admin
@@ -53,7 +53,7 @@ This command retrieves the SMB shares on the computer.
5353
### Example 2: Get a specific SMB share on the local computer
5454

5555
```powershell
56-
PS C:\\>Get-SmbShare -Name "VMS1"
56+
Get-SmbShare -Name "VMS1"
5757
Name ScopeName Path Description
5858
---- --------- ---- -----------
5959
VMS1 * I:\VMS
@@ -64,7 +64,7 @@ This command retrieves information about the SMB share named `VMS1` on the local
6464
### Example 3: Display information about the SMB shares on a remote computer
6565

6666
```powershell
67-
PS C:\\>get-smbshare -CimSession "NEDFS1"
67+
Get-SmbShare -CimSession "NEDFS1"
6868
6969
Name ScopeName Path Description PSComputerName
7070
---- --------- ---- ----------- --------------
@@ -76,15 +76,14 @@ IPC$ * Remote IPC ae-dfsr-sr-01
7676
IT dept * D:\\data\IT dept ae-dfsr-sr-01
7777
procedures * D:\\hr\procedures ae-dfsr-sr-01
7878
VHD and ISO * D:\\data\VHD and ISO ae-dfsr-sr-01
79-
8079
```
8180

8281
This command displays the information about the SMB shares on the remote computer `NEDFS1`.
8382

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

8685
```powershell
87-
PS C:\\>Get-SmbShare -Name "VMS1" | Format-List -Property *
86+
Get-SmbShare -Name "VMS1" | Format-List -Property *
8887
PresetPathAcl : System.Security.AccessControl.DirectorySecurity
8988
ShareState : Online
9089
AvailabilityType : Clustered
@@ -119,7 +118,7 @@ as a formatted list.
119118
### Example 5: Get shares on the local failover cluster computer that have scale out availability
120119

121120
```powershell
122-
PS C:\\>Get-SmbShare | Where-Object -Property AvailabilityType -Eq ScaleOut
121+
Get-SmbShare | Where-Object -Property AvailabilityType -Eq ScaleOut
123122
Name ScopeName Path Description
124123
---- --------- ---- -----------
125124
ClusterStorage$ Contoso-SO C:\\ClusterStorage Cluster Shared Volumes Def...
@@ -132,7 +131,7 @@ This command retrieves the SMB shares on the computer that have scaled out avail
132131
### Example 6: Get shares that are connected to a local failover cluster file server resource named "Contoso-FS"
133132

134133
```powershell
135-
PS C:\\>Get-SmbShare -ScopeName "Contoso-FS"
134+
Get-SmbShare -ScopeName "Contoso-FS"
136135
Name ScopeName Path Description
137136
---- --------- ---- -----------
138137
I$ Contoso-FS I:\ Cluster Default Share
@@ -222,7 +221,7 @@ Accept wildcard characters: False
222221
### -CimSession
223222
224223
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
225-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
224+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
226225
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
227226
current session on the local computer.
228227
@@ -337,8 +336,8 @@ Accept wildcard characters: False
337336
338337
### -IsolatedTransport
339338
340-
Specifies whether to use an isolated transport for the SMB share. An isolated transport provides
341-
additional security by encrypting and signing SMB traffic. The default value is `$false`.
339+
Treats this share to be a distinct file server instance. Clients will establish a new set of
340+
connections to access the share.
342341
343342
```yaml
344343
Type: Boolean[]
@@ -488,8 +487,12 @@ Accept wildcard characters: False
488487

489488
### -SmbInstance
490489

491-
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this
492-
cmdlet.
490+
Specifies the SMB share instance type. Accepted values are:
491+
492+
- `Default`: Used for operations where a client device opens a file on a share on the server.
493+
- `CSV`: Used by Windows Failover Clusters.
494+
- `SBL`: Used by Storage Spaces Direct.
495+
- `SR`: Used by Storage Replica.
493496

494497
```yaml
495498
Type: SmbInstance
@@ -546,7 +549,7 @@ Accept wildcard characters: False
546549
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
547550
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
548551
-WarningAction, and -WarningVariable. For more information, see
549-
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
552+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
550553

551554
## INPUTS
552555

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Accept wildcard characters: False
161161
### -CimSession
162162

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

@@ -512,7 +512,7 @@ Accept wildcard characters: False
512512
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
513513
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
514514
-WarningAction, and -WarningVariable. For more information, see
515-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
515+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
516516

517517
## INPUTS
518518

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ cmdlet to determine whether users are connected to a share.
4444
### Example 1: Delete an SMB share
4545

4646
```powershell
47-
PS C:\\>Remove-SmbShare -Name "Data"
47+
Remove-SmbShare -Name "Data"
4848
4949
5050
Confirm
@@ -86,7 +86,7 @@ Accept wildcard characters: False
8686
### -CimSession
8787
8888
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
89-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
89+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
9090
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
9191
current session on the local computer.
9292
@@ -205,7 +205,7 @@ Accept wildcard characters: False
205205
### -ThrottleLimit
206206
207207
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
208-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
208+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
209209
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
210210
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
211211
computer.
@@ -259,7 +259,7 @@ Accept wildcard characters: False
259259
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
260260
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
261261
-WarningAction, and -WarningVariable. For more information, see
262-
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
262+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
263263

264264
## INPUTS
265265

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The `Set-SmbShare` cmdlet modifies the properties of the Server Message Block (S
4949
### Example 1: Modify properties of an SMB share
5050

5151
```powershell
52-
PS C:\\>Set-SmbShare -Name "VMFiles" -EncryptData $True
52+
Set-SmbShare -Name "VMFiles" -EncryptData $True
5353
5454
5555
Confirm
@@ -63,7 +63,7 @@ This command modifies the properties of an SMB share.
6363
### Example 2: Modify properties of an SMB share without confirmation
6464

6565
```powershell
66-
PS C:\\>Set-SmbShare -Name "VMFiles" -EncryptData $True -Force
66+
Set-SmbShare -Name "VMFiles" -EncryptData $True -Force
6767
```
6868

6969
This command modifies the properties of an SMB share without user confirmation.
@@ -129,7 +129,7 @@ Accept wildcard characters: False
129129
### -CimSession
130130
131131
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
132-
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
132+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
133133
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
134134
current session on the local computer.
135135
@@ -533,18 +533,16 @@ Accept wildcard characters: False
533533
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
534534
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
535535
-WarningAction, and -WarningVariable. For more information, see
536-
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
536+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
537537

538538
## INPUTS
539539

540-
### System.String[]
540+
### System.String
541541

542542
### Microsoft.PowerShell.Cmdletization.GeneratedTypes.SmbShare.SmbInstance
543543

544544
### Microsoft.Management.Infrastructure.CimInstance[]
545545

546-
### System.String
547-
548546
### System.UInt32
549547

550548
### System.Boolean

0 commit comments

Comments
 (0)