Skip to content

Commit 46de96a

Browse files
committed
Add parameter and example MicrosoftDocs#2828
1 parent 90fda80 commit 46de96a

File tree

2 files changed

+58
-6
lines changed

2 files changed

+58
-6
lines changed

docset/winserver2019-ps/failoverclusters/Add-ClusterScaleOutFileServerRole.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Creates a clustered file server for scale-out application data.
1616
## SYNTAX
1717

1818
```
19-
Add-ClusterScaleOutFileServerRole [[-Name] <String>] [-Wait <Int32>] [-InputObject <PSObject>]
19+
Add-ClusterScaleOutFileServerRole [[-Name] <String>] [-Wait <Int32>] [-Infrastructure] [-InputObject <PSObject>]
2020
[-Cluster <String>] [<CommonParameters>]
2121
```
2222

@@ -32,8 +32,10 @@ Note: This cmdlet cannot be run remotely without Credential Security Service Pro
3232
## EXAMPLES
3333

3434
### Example 1
35-
```
35+
```powershell
3636
PS C:\> Add-ClusterScaleOutFileServerRole
37+
```
38+
```output
3739
Name OwnerNode State
3840
---- --------- -----
3941
clusterSOFS CLUSTER-N2 Online
@@ -42,8 +44,10 @@ clusterSOFS CLUSTER-N2
4244
This example creates a highly available Scale-out file server role.
4345

4446
### Example 2
45-
```
47+
```powershell
4648
PS C:\> Add-ClusterScaleOutFileServerRole -Wait 0
49+
```
50+
```output
4751
Name OwnerNode State
4852
---- --------- -----
4953
clusterSOFS CLUSTER-N2 Pending
@@ -52,6 +56,13 @@ clusterSOFS CLUSTER-N2
5256
This example creates a highly available scale out file server role.
5357
The cmdlet completes without waiting for all resources to come online.
5458

59+
### Example 3
60+
```powershell
61+
Add-ClusterScaleOutFileServerRole -Cluster MyCluster -Infrastructure -Name InfraSOFSName
62+
```
63+
64+
This example create Scale-Out File Server role - Infrastructure File Server. It will create a single namespace share automatically for the CSV drive (i.e. `\\InfraSOFSName\Volume1`, etc.). In hyper-converged configurations, an Infrastructure SOFS allows an SMB client (Hyper-V host) to communicate with guaranteed Continuous Availability (CA) to the Infrastructure SOFS SMB server. There can be at most only one infrastructure SOFS cluster role on a Failover Cluster.
65+
5566
## PARAMETERS
5667

5768
### -Cluster
@@ -70,6 +81,21 @@ Accept pipeline input: False
7081
Accept wildcard characters: False
7182
```
7283
84+
### -Infrastructure
85+
Specifies whether to create Infrastructure File Server Scale-Out File Server role
86+
87+
```yaml
88+
Type: SwitchParameter
89+
Parameter Sets: (All)
90+
Aliases:
91+
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
7399
### -InputObject
74100
Specifies the cluster on which to create the highly available scale-out file server.
75101

docset/winserver2022-ps/failoverclusters/Add-ClusterScaleOutFileServerRole.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Creates a clustered file server for scale-out application data.
1616
## SYNTAX
1717

1818
```
19-
Add-ClusterScaleOutFileServerRole [[-Name] <String>] [-Wait <Int32>] [-InputObject <PSObject>]
19+
Add-ClusterScaleOutFileServerRole [[-Name] <String>] [-Wait <Int32>] [-Infrastructure] [-InputObject <PSObject>]
2020
[-Cluster <String>] [<CommonParameters>]
2121
```
2222

@@ -32,8 +32,10 @@ Note: This cmdlet cannot be run remotely without Credential Security Service Pro
3232
## EXAMPLES
3333

3434
### Example 1
35-
```
35+
```powershell
3636
PS C:\> Add-ClusterScaleOutFileServerRole
37+
```
38+
```output
3739
Name OwnerNode State
3840
---- --------- -----
3941
clusterSOFS CLUSTER-N2 Online
@@ -42,8 +44,10 @@ clusterSOFS CLUSTER-N2
4244
This example creates a highly available Scale-out file server role.
4345

4446
### Example 2
45-
```
47+
```powershell
4648
PS C:\> Add-ClusterScaleOutFileServerRole -Wait 0
49+
```
50+
```output
4751
Name OwnerNode State
4852
---- --------- -----
4953
clusterSOFS CLUSTER-N2 Pending
@@ -52,6 +56,13 @@ clusterSOFS CLUSTER-N2
5256
This example creates a highly available scale out file server role.
5357
The cmdlet completes without waiting for all resources to come online.
5458

59+
### Example 3
60+
```powershell
61+
Add-ClusterScaleOutFileServerRole -Cluster MyCluster -Infrastructure -Name InfraSOFSName
62+
```
63+
64+
This example create Scale-Out File Server role - Infrastructure File Server. It will create a single namespace share automatically for the CSV drive (i.e. `\\InfraSOFSName\Volume1`, etc.). In hyper-converged configurations, an Infrastructure SOFS allows an SMB client (Hyper-V host) to communicate with guaranteed Continuous Availability (CA) to the Infrastructure SOFS SMB server. There can be at most only one infrastructure SOFS cluster role on a Failover Cluster.
65+
5566
## PARAMETERS
5667

5768
### -Cluster
@@ -70,6 +81,21 @@ Accept pipeline input: False
7081
Accept wildcard characters: False
7182
```
7283
84+
### -Infrastructure
85+
Specifies whether to create Infrastructure File Server Scale-Out File Server role
86+
87+
```yaml
88+
Type: SwitchParameter
89+
Parameter Sets: (All)
90+
Aliases:
91+
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
7399
### -InputObject
74100
Specifies the cluster on which to create the highly available scale-out file server.
75101

0 commit comments

Comments
 (0)