Skip to content

Commit

Permalink
Merge pull request #3161 from robinharwood/roharwoo_clusterawareupdat…
Browse files Browse the repository at this point in the history
…ing_rebase

ClusterAwareUpdating module changes for WS2022
  • Loading branch information
Xelu86 committed Jul 15, 2024
2 parents e2fbe31 + d4f27e3 commit af89243
Show file tree
Hide file tree
Showing 10 changed files with 1,190 additions and 415 deletions.
418 changes: 305 additions & 113 deletions docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ Exports one or more Updating Run reports into an HTML or CSV-formatted document.
### [Get-CauClusterRole](./Get-CauClusterRole.md)
Gets configuration properties of the CAU clustered role on the specified cluster.

### [Get-CauPlugin](./Get-CauPlugin.md)
Gets information about one or more software updating plug-ins that are registered on the local
computer.
### [Get-CauDeviceInfoForFeatureUpdates](Get-CauDeviceInfoForFeatureUpdates.md)
Gets device information for feature updates to use with CAU.

### [Get-CauPlugin](Get-CauPlugin.md)
Gets information about one or more software updating plug-ins that are registered on the local computer.

### [Get-CauReport](./Get-CauReport.md)
Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the
Expand Down Expand Up @@ -70,5 +72,3 @@ Tests whether a cluster is properly set up to apply software updates using CAU.

### [Unregister-CauPlugin](./Unregister-CauPlugin.md)
Removes a software updating plug-in from the list of plug-ins that are used by CAU.


Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ cluster. The self-updating functionality of the cluster can be disabled with the
Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
```

This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating
Runs. The cmdlet changes the status of the CAU clustered role to Running. Because the command
specified the **Force** parameter, the cmdlet runs without displaying confirmation prompts.
This command enables the CAU clustered role on the **CONTOSO-FC1** cluster to begin performing
Updating Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs
without displaying confirmation prompts, as the **Force** parameter was used.

## PARAMETERS

Expand All @@ -58,28 +58,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
### -Credential
Prompts you for confirmation before running the cmdlet.
Specifies the administrative credentials for the target cluster.
```yaml
Type: SwitchParameter
Type: PSCredential
Parameter Sets: (All)
Aliases: cf
Aliases:

Required: False
Position: Named
Default value: False
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Credential
### -Force
Specifies the administrative credentials for the target cluster.
Forces the command to run without asking for user confirmation.
```yaml
Type: PSCredential
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -90,26 +90,25 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Force
### -Confirm
Forces the command to run without asking for user confirmation.
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet isn't run.
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
```yaml
Type: SwitchParameter
Expand All @@ -128,27 +127,26 @@ Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
## INPUTS
### None
## OUTPUTS
### None
### System.Object
## NOTES
## RELATED LINKS
[Add-CauClusterRole](./Add-CauClusterRole.md)
[Disable-CauClusterRole](./Disable-CauClusterRole.md)
[Add-CauClusterRole](add-cauclusterrole.md)
[Get-CauClusterRole](./Get-CauClusterRole.md)
[Disable-CauClusterRole](disable-cauclusterrole.md)
[Remove-CauClusterRole](./Remove-CauClusterRole.md)
[Get-CauClusterRole](get-cauclusterrole.md)
[Set-CauClusterRole](./Set-CauClusterRole.md)
[Remove-CauClusterRole](remove-cauclusterrole.md)
[Set-CauClusterRole](set-cauclusterrole.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
description: The Get-CauDeviceInfoForFeatureUpdates cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU).
external help file: ClusterAwareUpdating.dll-Help.xml
Module Name: ClusterAwareUpdating
ms.date: 09/17/2021
online version: https://docs.microsoft.com/powershell/module/clusterawareupdating/get-caudeviceinfoforfeatureupdates?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-CauDeviceInfoForFeatureUpdates
---

# Get-CauDeviceInfoForFeatureUpdates

## SYNOPSIS
Gets device information for feature updates to use with CAU.

## SYNTAX

```
Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] <String>] [-Credential <PSCredential>]
-PathToDirectory <String> [<CommonParameters>]
```

## DESCRIPTION

The `Get-CauDeviceInfoForFeatureUpdates` cmdlet gets device information for feature updates to use
with Cluster-Aware Updating (CAU).

## EXAMPLES

### Example 1: Get device information

```powershell
$Parameters = @{
ClusterName = 'CONTOSO-FC1'
PathToDirectory = 'C:\temp\contoso-device-info'
}
Get-CauDeviceInfoForFeatureUpdates $Parameters
```

This example gets device information for CAU for the specified cluster. This example uses
splatting to pass parameter values from the `$Parameters` variable to the command. Learn more about
[Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).

## PARAMETERS

### -ClusterName

Specifies the name of the cluster fow which to get device information.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Credential
Specifies the administrative credentials for the target cluster.
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PathToDirectory
Specifies a directory.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
## INPUTS
### None
## OUTPUTS
### System.String
### Microsoft.ClusterAwareUpdating.ActivityIdMap
## NOTES
## RELATED LINKS
[Get-CauClusterRole](get-cauclusterrole.md)
[Get-CauPlugin](get-cauplugin.md)
[Get-CauReport](get-caureport.md)
[Get-CauRun](get-caurun.md)
37 changes: 19 additions & 18 deletions docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,40 @@ specified dates or other specified parameters.
### AllParamsSet (Default)

```
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>]
[<CommonParameters>]
```

### RangeParamSet

```
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-Detailed]
[-Credential <PSCredential>] [<CommonParameters>]
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>]
[-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
```

### LastParamSet

```
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>]
[<CommonParameters>]
```

### SpecificReportParamSet

```
Get-CauReport [[-ClusterName] <String>] [-Report <CauReportSummary>] [-Credential <PSCredential>]
[<CommonParameters>]
Get-CauReport [[-ClusterName] <String>] [-Report <CauReportSummary>]
[-Credential <PSCredential>] [<CommonParameters>]
```

## DESCRIPTION

The `Get-CauReport` cmdlet gets the Updating Run reports for all known Updating Runs, or all
Updating Runs that match the specified dates or other specified parameters. This cmdlet can return a
list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or if
the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent Updating
Run report. By default, the report contains summaries only, but more detail can be obtained with the
**Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware Updating
(CAU) report summary object.
list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or
if the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent
Updating Run report. By default, the report contains summaries only, but more detail can be obtained
with the **Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware
Updating (CAU) report summary object.

## EXAMPLES

Expand All @@ -60,16 +62,16 @@ Run report. By default, the report contains summaries only, but more detail can
Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
```

This command gets a detailed list of the updating runs performed on the cluster named Contoso-FC1 on
01/01/2012 or later.
This command gets a detailed list of the updating runs performed on the cluster named **Contoso-FC1**
on 01/01/2012 or later.

### Example 2: Get a detailed list of updating runs from a date span from the specified cluster

```powershell
Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
```

This command gets a detailed list of the updating runs performed on the cluster called Contoso-FC1
This command gets a detailed list of the updating runs performed on the cluster called **Contoso-FC1**
starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012.

### Example 3: Get the last updating run summary from the specified cluster
Expand All @@ -79,7 +81,7 @@ $CauReportSummary = Get-CauReport "Contoso-FC1" -Last
Get-CauReport "Contoso-FC1" -Report $CauReportSummary
```

The first command gets the last updating run report summary from the cluster named Contoso-FC1 and
The first command gets the last updating run report summary from the cluster named **Contoso-FC1** and
stores the result in the variable named `$CauReportSummary`.

The second command gets the detailed report from the information stored in the `$CauReportSummary`
Expand Down Expand Up @@ -206,7 +208,7 @@ Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
## INPUTS
Expand All @@ -222,5 +224,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## RELATED LINKS
[Export-CauReport](./Export-CauReport.md)
[Export-CauReport](export-caureport.md)
Loading

0 comments on commit af89243

Please sign in to comment.