Skip to content

Commit f9b1e2d

Browse files
authored
Merge pull request MicrosoftDocs#2489 from velkovb/fix/2450-what-if
Resolves MicrosoftDocs#2450
2 parents a134e1a + 8371260 commit f9b1e2d

File tree

5 files changed

+158
-153
lines changed

5 files changed

+158
-153
lines changed

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

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ To delete a share that was created by this cmdlet, use the Remove-SMBShare cmdle
3030
### EXAMPLE 1
3131
```
3232
PS C:\>New-SmbShare -Name VMSFiles -Path C:\ClusterStorage\Volume1\VMFiles -FullAccess Contoso\Administrator, Contoso\Contoso-HV1$
33-
Name ScopeName Path Description
34-
---- --------- ---- -----------
33+
Name ScopeName Path Description
34+
---- --------- ---- -----------
3535
VMSFiles Contoso-SO C:\ClusterStorage\Volume1\...
3636
```
3737

@@ -40,8 +40,8 @@ This example creates a new SMB share.
4040
### EXAMPLE 2
4141
```
4242
PS C:\>New-SmbShare -Name Data -Path J:\Data -EncryptData $true
43-
Name ScopeName Path Description
44-
---- --------- ---- -----------
43+
Name ScopeName Path Description
44+
---- --------- ---- -----------
4545
Data Contoso-FS J:\Data
4646
```
4747

@@ -55,7 +55,7 @@ ps_cimcommon_asjob
5555
```yaml
5656
Type: SwitchParameter
5757
Parameter Sets: (All)
58-
Aliases:
58+
Aliases:
5959

6060
Required: False
6161
Position: Named
@@ -68,20 +68,20 @@ Accept wildcard characters: False
6868
Specifies the caching mode of the offline files for the SMB share.
6969
There are five different caching modes:
7070
71-
-- None: Prevents users from storing documents and programs offline.
71+
-- None: Prevents users from storing documents and programs offline.
7272
73-
-- Manual: Allows users to identify the documents and programs they want to store offline.
73+
-- Manual: Allows users to identify the documents and programs they want to store offline.
7474
75-
-- Programs: Automatically stores documents and programs offline.
75+
-- Programs: Automatically stores documents and programs offline.
7676
77-
-- Documents: Automatically stores documents offline.
77+
-- Documents: Automatically stores documents offline.
7878
7979
-- BranchCache: Enables BranchCache and manual caching of documents on the shared folder.
8080
8181
```yaml
8282
Type: CachingMode
8383
Parameter Sets: (All)
84-
Aliases:
84+
Aliases:
8585

8686
Required: False
8787
Position: Named
@@ -96,7 +96,7 @@ Specifies the continuous availability timeout for the share.
9696
```yaml
9797
Type: UInt32
9898
Parameter Sets: (All)
99-
Aliases:
99+
Aliases:
100100

101101
Required: False
102102
Position: Named
@@ -112,7 +112,7 @@ Multiple users can be specified by using a comma-separated list.
112112
```yaml
113113
Type: String[]
114114
Parameter Sets: (All)
115-
Aliases:
115+
Aliases:
116116

117117
Required: False
118118
Position: Named
@@ -129,7 +129,7 @@ The default is the current session on the local computer.
129129
```yaml
130130
Type: CimSession[]
131131
Parameter Sets: (All)
132-
Aliases:
132+
Aliases:
133133

134134
Required: False
135135
Position: Named
@@ -146,7 +146,7 @@ The default value is zero (0).
146146
```yaml
147147
Type: UInt32
148148
Parameter Sets: (All)
149-
Aliases:
149+
Aliases:
150150

151151
Required: False
152152
Position: Named
@@ -161,7 +161,7 @@ Indicates that the share is continuously available.
161161
```yaml
162162
Type: Boolean
163163
Parameter Sets: (All)
164-
Aliases:
164+
Aliases:
165165

166166
Required: False
167167
Position: Named
@@ -179,7 +179,7 @@ The default value no description, or an empty description
179179
```yaml
180180
Type: String
181181
Parameter Sets: (All)
182-
Aliases:
182+
Aliases:
183183

184184
Required: False
185185
Position: Named
@@ -194,7 +194,7 @@ Indicates that the share is encrypted.
194194
```yaml
195195
Type: Boolean
196196
Parameter Sets: (All)
197-
Aliases:
197+
Aliases:
198198

199199
Required: False
200200
Position: Named
@@ -207,17 +207,17 @@ Accept wildcard characters: False
207207
Specifies which files and folders in the new SMB share are visible to users.
208208
The acceptable values for this parameter are:
209209
210-
-- AccessBased: SMB will not the display the files and folders for a share to a user unless that user has rights to access the files and folders.
210+
-- AccessBased: SMB will not display the files and folders for a share to a user unless that user has rights to access the files and folders.
211211
By default, access-based enumeration is disabled for new SMB shares.
212212
213-
-- Unrestricted: SMB will display files and folders to a user even when the user does not have permission to access the items.
213+
-- Unrestricted: SMB will display files and folders to a user even when the user does not have permission to access the items.
214214
215215
The default value is Unrestricted.
216216
217217
```yaml
218218
Type: FolderEnumerationMode
219219
Parameter Sets: (All)
220-
Aliases:
220+
Aliases:
221221

222222
Required: False
223223
Position: Named
@@ -234,7 +234,7 @@ An account may not be specified more than once in the FullAccess, ChangeAccess,
234234
```yaml
235235
Type: String[]
236236
Parameter Sets: (All)
237-
Aliases:
237+
Aliases:
238238

239239
Required: False
240240
Position: Named
@@ -251,7 +251,7 @@ The names `pipe` and `mailslot` are reserved for use by the computer.
251251
```yaml
252252
Type: String
253253
Parameter Sets: (All)
254-
Aliases:
254+
Aliases:
255255
256256
Required: True
257257
Position: 2
@@ -267,7 +267,7 @@ Multiple accounts can be specified by supplying a comma-separated list.
267267
```yaml
268268
Type: String[]
269269
Parameter Sets: (All)
270-
Aliases:
270+
Aliases:
271271
272272
Required: False
273273
Position: Named
@@ -283,7 +283,7 @@ The path must be fully qualified; relative paths or paths that contain wildcard
283283
```yaml
284284
Type: String
285285
Parameter Sets: (All)
286-
Aliases:
286+
Aliases:
287287
288288
Required: True
289289
Position: 3
@@ -299,7 +299,7 @@ Multiple users can be specified by supplying a comma-separated list.
299299
```yaml
300300
Type: String[]
301301
Parameter Sets: (All)
302-
Aliases:
302+
Aliases:
303303
304304
Required: False
305305
Position: Named
@@ -314,7 +314,7 @@ Specifies the scope name of the share.
314314
```yaml
315315
Type: String
316316
Parameter Sets: (All)
317-
Aliases:
317+
Aliases:
318318
319319
Required: False
320320
Position: 4
@@ -331,7 +331,7 @@ By default, new SMB shares are persistent, and non-temporary.
331331
```yaml
332332
Type: SwitchParameter
333333
Parameter Sets: (All)
334-
Aliases:
334+
Aliases:
335335
336336
Required: False
337337
Position: Named
@@ -348,7 +348,7 @@ The throttle limit applies only to the current cmdlet, not to the session or to
348348
```yaml
349349
Type: Int32
350350
Parameter Sets: (All)
351-
Aliases:
351+
Aliases:
352352
353353
Required: False
354354
Position: Named
@@ -363,7 +363,7 @@ Prompts you for confirmation before running the cmdlet.
363363
```yaml
364364
Type: SwitchParameter
365365
Parameter Sets: (All)
366-
Aliases:
366+
Aliases:
367367
368368
Required: False
369369
Position: Named
@@ -376,10 +376,12 @@ Accept wildcard characters: False
376376
Shows what would happen if the cmdlet runs.
377377
The cmdlet is not run.
378378

379+
NOTE: The WhatIf switch does not work with this cmdlet.
380+
379381
```yaml
380382
Type: SwitchParameter
381383
Parameter Sets: (All)
382-
Aliases:
384+
Aliases:
383385
384386
Required: False
385387
Position: Named
@@ -409,4 +411,3 @@ The MSFT_SmbShare object represents the new SMB share.
409411
[Remove-SmbShare](./Remove-SmbShare.md)
410412

411413
[Set-SmbShare](./Set-SmbShare.md)
412-

0 commit comments

Comments
 (0)