Update-DataGatewayClusterMember
Start a update when newer version available or check the last update status on the specified gateway member in the cluster.
To use this cmdlet, your gateway version must be 3000.294.7 (Nov 2025) or higher.
Syntax
Default (Default)
Update-DataGatewayClusterMember
-GatewayClusterId <Guid>
[-MemberGatewayId <Guid>]
[-CheckStatus]
[-TargetVersion <Version>]
[<CommonParameters>]
Description
Start a update when newer version available or check the last update status on the specified gateway member in the cluster
Examples
Example 1
PS C:\> Update-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77
GatewayObjectId GatewayVersion Status
--------------- -------------- ------
DC8F2C49-5731-4B27-966B-3DB5094C2E77 3000.262.13 Acknowledged
Start update to the latest version on the primary gateway in cluster ID 64C574B7-86C6-4560-B710-40AC18990804
Example 2
PS C:\> Update-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -MemberGatewayId 64C574B7-86C6-4560-B710-40AC18990804 -TargetVersion 3000.294.7
GatewayObjectId GatewayVersion Status
--------------- -------------- ------
64C574B7-86C6-4560-B710-40AC18990804 3000.262.13 Acknowledged
Start update to the version 3000.294.7 on the specified gateway member ID 64C574B7-86C6-4560-B710-40AC18990804 in gateway cluster ID DC8F2C49-5731-4B27-966B-3DB5094C2E77
Example 3
PS C:\> Update-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -CheckStatus
GatewayObjectId GatewayVersion Status
--------------- -------------- ------
DC8F2C49-5731-4B27-966B-3DB5094C2E77 3000.262.13 InProgress
Get the last update status for the primary gateway in cluster ID 64C574B7-86C6-4560-B710-40AC18990804
Parameters
-CheckStatus
Indicates to check the last update status only and not start the update operation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GatewayClusterId
The ID of the gateway cluster that has the Gateway update. It has to be an existing gateway cluster on the same tenant.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Cluster, Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MemberGatewayId
This is the Id of the gateway to update. It has to be an existing gateway in the cluster.
Parameter properties
| Type: | Guid |
| Default value: | GatewayClusterId |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetVersion
The target version to update to. To get the list of supported versions run the Get-DataGatewayAvailableUpdates command
Parameter properties
| Type: | Version |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.