Edit

Share via

Get-SRPartnership

Module:
StorageReplica Module

Gets replication partnerships.

Syntax

NonCluster (Default) 

Get-SRPartnership
    [[-SourceComputerName] <String>]
    [[-SourceRGName] <String>]
    [[-DestinationComputerName] <String>]
    [[-DestinationRGName] <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

FromGroup 

Get-SRPartnership
    [[-ComputerName] <String>]
    [[-Name] <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-SRPartnership cmdlet gets existing replication partnerships. A partnership is the replication relationship between replication groups on a pair of servers, a pair of clusters, or nodes in a stretch cluster.

Examples

Example 1: Get all partnerships on a computer

PS C:\>Get-SRPartnership
DestinationComputerName : SR-SRV06
DestinationRGName       : ReplicationGroup02
Id                      : 084afd15-3340-4695-9f9a-5fdc666a89c6
SourceComputerName      : SR-SRV05
SourceRGName            : ReplicationGroup01
PSComputerName          :

This command gets all partnerships on the local computer.

Example 2: Get partnerships between two servers

PS C:\>Get-SRPartnership -SourceComputerName "SR-SRV05" -DestinationComputerName "SR-SRV06"
DestinationComputerName : SR-SRV06
DestinationRGName       : ReplicationGroup02
Id                      : 084afd15-3340-4695-9f9a-5fdc666a89c6
SourceComputerName      : SR-SRV05
SourceRGName            : ReplicationGroup01
PSComputerName          :

This command gets all partnerships between the strand-alone servers named SR-SRV05 and SR-SRV06.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

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

-ComputerName

Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN) of a computer on which this cmdlet gets partnerships.

Parameter properties

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

Parameter sets

FromGroup
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DestinationComputerName

Specifies a single replica host computer NetBIOS name or FQDN of the destination computer for which this cmdlet gets partnerships.

Parameter properties

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

Parameter sets

NonCluster
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DestinationRGName

Specifies the name of the destination replication group for which this cmdlet gets partnerships.

Parameter properties

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

Parameter sets

NonCluster
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of a partnership that this cmdlet gets.

Parameter properties

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

Parameter sets

FromGroup
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SourceComputerName

Specifies a single replica source host computer NetBIOS name or FQDN for which this cmdlet gets partnerships. The default value is the local computer.

Parameter properties

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

Parameter sets

NonCluster
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SourceRGName

Specifies the name of the source replication group for which this cmdlet gets partnerships.

Parameter properties

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

Parameter sets

NonCluster
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Parameter properties

Type:Int32
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.

Outputs

replicationgroups