Wes Carroll
59a0a53812
* Establish a help system * Continue to update Help System * Update Get-ZertoAlert.md * Update Get-ZertoDatastore.md * Add Link to Zerto API for Datastores * Update Get-ZertoLicense.md * Update Links to Zerto API documentation * Update the Readme Information * Continue to update README * Update README * Update README.md * Update Help Markdown Files * Correct API URL * Update ZertoApiWrapper-help.xml * Update Get-ZertoProtectedVm.md * Update Help Markdown files * Update Get-ZertoVpgSetting.md * Added online url to each help object. * Update Help Markdown Files * Update ZertoApiWrapper-help.xml
3.9 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| ZertoApiWrapper-help.xml | ZertoApiWrapper | https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoPeerSite.md | 2.0.0 |
Get-ZertoPeerSite
SYNOPSIS
Returns information about the peer sites.
SYNTAX
main (Default)
Get-ZertoPeerSite [<CommonParameters>]
pairingStatuses
Get-ZertoPeerSite [-pairingStatuses] [<CommonParameters>]
siteIdentifier
Get-ZertoPeerSite -siteIdentifier <String[]> [<CommonParameters>]
filter
Get-ZertoPeerSite [-peerName <String>] [-paringStatus <String>] [-location <String>] [-hostName <String>]
[-port <String>] [<CommonParameters>]
DESCRIPTION
Returns information about a peer site. When called without any parameters, will return basic information about all peer sites.
EXAMPLES
Example 1
PS C:\> Get-ZertoPeerSite
Returns basic information about all sites connected to this site.
Example 1
PS C:\> Get-ZertoPeerSite -siteIdentifier "MySiteIdentifier"
Returns basic information about site with site identifier "MySiteIdentifier"
PARAMETERS
-hostName
The IP address of a Zerto Virtual Manager, paired with this site, for which information is to be returned.
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-location
The site location, as specified in the site information, for which information is to be returned.
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pairingStatuses
Switch to return possible paiting statuses.
Type: SwitchParameter
Parameter Sets: pairingStatuses
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-paringStatus
The pairing status for which information is to be returned.
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-peerName
The name of a peer site for which information is to be returned. The name is case-sensitive.
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-port
The port used to access peer sites for which information is to be returned. The default port is 9081.
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-siteIdentifier
The identifier(s) of the peer site(s) for which information is to be returned.
Type: String[]
Parameter Sets: siteIdentifier
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).