Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEW CAU cmdlets & parameter updates #3833

Merged
merged 4 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
486 changes: 357 additions & 129 deletions docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: ClusterAwareUpdating.dll-Help.xml
Module Name: ClusterAwareUpdating
ms.date: 07/01/2024
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caudeviceinfoforfeatureupdates?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-CauDeviceInfoForFeatureUpdates
---

# Get-CauDeviceInfoForFeatureUpdates

## SYNOPSIS
Retrieves device information for feature updates from a specified directory.

## SYNTAX

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

## DESCRIPTION

The `Get-CauDeviceInfoForFeatureUpdates` cmdlet retrieves device information for feature updates
from a specified directory.

## EXAMPLES

### Example 1

```powershell
$parameters = @{
ClusterName = "CONTOSO-FC1"
PathToDirectory = "C:\Updates"
PathToDeploymentCab = "C:\Deployment\FeatureUpdate.cab"
}
Get-CauDeviceInfoForFeatureUpdates $parameters
```

This command retrieves device information for feature updates from the `C:\Updates` directory for
the cluster named **CONTOSO-FC1**. It also specifies the path to the deployment cab file that will
be created for the update in `C:\Deployment\FeatureUpdate.cab`.

## PARAMETERS

### -ClusterName

Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only
required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference
a failover cluster different from where the cmdlet is run.

```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
```

### -PathToDeploymentCab

Specifies the path to the deployment cab file that will be created for the update.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PathToDirectory

Specifies the path to the directory that contains the device information files. This parameter is
required.

```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
103 changes: 103 additions & 0 deletions docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: ClusterAwareUpdating.dll-Help.xml
Module Name: ClusterAwareUpdating
ms.date: 07/01/2024
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-clusterlesscaurun?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-ClusterlessCauRun
---

# Get-ClusterlessCauRun

## SYNOPSIS
Retrieves information about a Cluster-Aware Updating (CAU) run not associated with a cluster.

## SYNTAX

### DefaultParamSet (Default)

```
Get-ClusterlessCauRun [-Credential <PSCredential>] [<CommonParameters>]
```

### ShowClusterNodeState

```
Get-ClusterlessCauRun [-Credential <PSCredential>] [-ShowClusterNodeState] [<CommonParameters>]
```

## DESCRIPTION

The `Get-ClusterlessCauRun` cmdlet retrieves information about a Cluster-Aware Updating (CAU) run
that is not associated with a cluster.

## EXAMPLES

### Example 1

```powershell
Get-ClusterlessCauRun
```

This example displays information about the current CAU run, including the status of each node that
is being updated.

## PARAMETERS

### -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
```

### -ShowClusterNodeState

Displays detailed information about the state of each node in the CAU run.

```yaml
Type: SwitchParameter
Parameter Sets: ShowClusterNodeState
Aliases:

Required: False
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

### Microsoft.ClusterAwareUpdating.CauWmiObject

### Microsoft.ClusterAwareUpdating.ClusterlessCauRun

### Microsoft.ClusterAwareUpdating.RunState

## NOTES

## RELATED LINKS

[Invoke-ClusterlessCauRun](invoke-clusterlesscaurun.md)
Loading