Skip to content

Commit e2fbe31

Browse files
Xelu86Xelu86
authored
Merge pull request #3833 from Xelu86/update_caucmdlets
NEW CAU cmdlets & parameter updates
2 parents cbd353f + 21974d0 commit e2fbe31

8 files changed

+1937
-436
lines changed

‎docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md

+357-129
Large diffs are not rendered by default.

‎docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: ClusterAwareUpdating.dll-Help.xml
4+
Module Name: ClusterAwareUpdating
5+
ms.date: 07/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caudeviceinfoforfeatureupdates?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-CauDeviceInfoForFeatureUpdates
9+
---
10+
11+
# Get-CauDeviceInfoForFeatureUpdates
12+
13+
## SYNOPSIS
14+
Retrieves device information for feature updates from a specified directory.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] <String>] [-Credential <PSCredential>]
20+
-PathToDirectory <String> [-PathToDeploymentCab <String>] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
The `Get-CauDeviceInfoForFeatureUpdates` cmdlet retrieves device information for feature updates
26+
from a specified directory.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
32+
```powershell
33+
$parameters = @{
34+
ClusterName = "CONTOSO-FC1"
35+
PathToDirectory = "C:\Updates"
36+
PathToDeploymentCab = "C:\Deployment\FeatureUpdate.cab"
37+
}
38+
Get-CauDeviceInfoForFeatureUpdates $parameters
39+
```
40+
41+
This command retrieves device information for feature updates from the `C:\Updates` directory for
42+
the cluster named **CONTOSO-FC1**. It also specifies the path to the deployment cab file that will
43+
be created for the update in `C:\Deployment\FeatureUpdate.cab`.
44+
45+
## PARAMETERS
46+
47+
### -ClusterName
48+
49+
Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only
50+
required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference
51+
a failover cluster different from where the cmdlet is run.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: False
59+
Position: 0
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -Credential
66+
67+
Specifies the administrative credentials for the target cluster.
68+
69+
```yaml
70+
Type: PSCredential
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -PathToDeploymentCab
82+
83+
Specifies the path to the deployment cab file that will be created for the update.
84+
85+
```yaml
86+
Type: String
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -PathToDirectory
98+
99+
Specifies the path to the directory that contains the device information files. This parameter is
100+
required.
101+
102+
```yaml
103+
Type: String
104+
Parameter Sets: (All)
105+
Aliases:
106+
107+
Required: True
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
### CommonParameters
115+
116+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
117+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
118+
-WarningAction, and -WarningVariable. For more information, see
119+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
120+
121+
## INPUTS
122+
123+
### None
124+
125+
## OUTPUTS
126+
127+
### System.String
128+
129+
### Microsoft.ClusterAwareUpdating.ActivityIdMap
130+
131+
## NOTES
132+
133+
## RELATED LINKS

‎docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: ClusterAwareUpdating.dll-Help.xml
4+
Module Name: ClusterAwareUpdating
5+
ms.date: 07/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-clusterlesscaurun?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-ClusterlessCauRun
9+
---
10+
11+
# Get-ClusterlessCauRun
12+
13+
## SYNOPSIS
14+
Retrieves information about a Cluster-Aware Updating (CAU) run not associated with a cluster.
15+
16+
## SYNTAX
17+
18+
### DefaultParamSet (Default)
19+
20+
```
21+
Get-ClusterlessCauRun [-Credential <PSCredential>] [<CommonParameters>]
22+
```
23+
24+
### ShowClusterNodeState
25+
26+
```
27+
Get-ClusterlessCauRun [-Credential <PSCredential>] [-ShowClusterNodeState] [<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
The `Get-ClusterlessCauRun` cmdlet retrieves information about a Cluster-Aware Updating (CAU) run
33+
that is not associated with a cluster.
34+
35+
## EXAMPLES
36+
37+
### Example 1
38+
39+
```powershell
40+
Get-ClusterlessCauRun
41+
```
42+
43+
This example displays information about the current CAU run, including the status of each node that
44+
is being updated.
45+
46+
## PARAMETERS
47+
48+
### -Credential
49+
50+
Specifies the administrative credentials for the target cluster.
51+
52+
```yaml
53+
Type: PSCredential
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: False
58+
Position: Named
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -ShowClusterNodeState
65+
66+
Displays detailed information about the state of each node in the CAU run.
67+
68+
```yaml
69+
Type: SwitchParameter
70+
Parameter Sets: ShowClusterNodeState
71+
Aliases:
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### CommonParameters
81+
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
83+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
84+
-WarningAction, and -WarningVariable. For more information, see
85+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
86+
87+
## INPUTS
88+
89+
### None
90+
91+
## OUTPUTS
92+
93+
### Microsoft.ClusterAwareUpdating.CauWmiObject
94+
95+
### Microsoft.ClusterAwareUpdating.ClusterlessCauRun
96+
97+
### Microsoft.ClusterAwareUpdating.RunState
98+
99+
## NOTES
100+
101+
## RELATED LINKS
102+
103+
[Invoke-ClusterlessCauRun](invoke-clusterlesscaurun.md)

0 commit comments

Comments
 (0)