Share via

Add-DataGatewayClusterMember

Module:
DataGateway Module

Creates a new data gateway cluster member in an existing cluster once the gateway has been installed on a machine

To use this cmdlet, your gateway version must be 3000.162.9 (Feb 2023) or higher. These cmdlets require Powershell 7 or higher. For more information, see the online documentation for installation guidelines.

Syntax

Default (Default) 

Add-DataGatewayClusterMember
    -RecoveryKey <SecureString>
    -GatewayName <String>
    [-RegionKey <String>]
    [-OverwriteExistingGateway]
    [<CommonParameters>]

Description

Creates a new data gateway cluster member once the gateway has been installed on a machine

Examples

Example 1

$addDataGatewayClusterMemberSplat = @{
    RecoveryKey = (Read-Host "Recovery Key" -AsSecureString)
    GatewayName = "MyNewGatewayMember"
    GatewayClusterId = "14e63994-6c2c-4fda-a2b1-3fc27079c855"
}
Add-DataGatewayClusterMember @addDataGatewayClusterMemberSplat

Example 2

$secureRecoveryKey = Read-Host "Enter Recovery Key" -AsSecureString
$addDataGatewayClusterMemberSplat = @{
    RecoveryKey = $secureRecoveryKey
    Name = "MyNewGatewayMember"
    GatewayClusterId = "14e63994-6c2c-4fda-a2b1-3fc27079c855"
}
Add-DataGatewayClusterMember @addDataGatewayClusterMemberSplat

Creates a new gateway named "MyNewGateway" in the Brazil South region. You can securely store the encrypted recovery key in a file and pass that into Add-DataGatewayCluster without any user interaction.

Parameters

-GatewayClusterId

Gateway cluster to which the data source belongs.

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

-GatewayName

This is the name of the gateway cluster that will be created. It cannot conflict with any existing gateways on the same tenant.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OverwriteExistingGateway

When this parameter is set it would overwrite the existing gateway configuration on the local machine and configure a new one. The overwritten gateway can still be recovered on another computer.

Parameter properties

Type:SwitchParameter
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

-RecoveryKey

The recovery key is used by the gateway to encrypt/decrypt on-prem credentials. This is also requried to restore the gateway or add a new member to the gateway cluster.

Parameter properties

Type:SecureString
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
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.

Inputs

None

Outputs

None

Notes

This command must be run with a user based credential.