Files
ZertoApiWrapper/docs/Get-ZANetworkSiteSummary.md
T
2020-04-04 10:26:56 -04:00

4.2 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteSummary.md 2.0.0

Get-ZANetworkSiteSummary

SYNOPSIS

Get a network executive summary for sites, filtered by start date and end date.

SYNTAX

ProtectedSite (Default)

Get-ZANetworkSiteSummary -protectedSiteIdentifier <String> [-recoverySiteIdentifier <String>]
 [-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]

RecoverySite

Get-ZANetworkSiteSummary [-protectedSiteIdentifier <String>] -recoverySiteIdentifier <String>
 [-startDate <String>] [-endDate <String>] [-zOrgIdentifier <String>] [<CommonParameters>]

DESCRIPTION

Get a network executive summary for sites, filtered by start date and end date.The following options are available:

  • To view the network executive summary of all outgoing traffic from a protected site to all its replicating sites, specify only the protected site identifier.
  • To view the network executive summary between two sites, specify both the protected site identifier and the recovery site identifier.

EXAMPLES

Example 1

PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678"

Returns outgoing networks summary from site with identifier "7890-1234-5678"

Example 2

PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678" -recoverySiteIdentifier "9876-5432-1098"

Returns network summary between sites with identifiers "7890-1234-5678" and "9876-5432-1098"

PARAMETERS

-endDate

End date in RFC 3339 standard ('1970-01-01T00:00:00Z'). If the end date is omitted, the default end date is the current time.

Type: String
Parameter Sets: (All)
Aliases:

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

-protectedSiteIdentifier

Protected site identifier. A site identification is required for at least one of the sites.

Type: String
Parameter Sets: ProtectedSite
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: RecoverySite
Aliases:

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

-recoverySiteIdentifier

Recovery site identifier. If the recovery site identifier is omitted, the API will show all outgoing traffic from the protected site to its replicating sites.

Type: String
Parameter Sets: ProtectedSite
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: RecoverySite
Aliases:

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

-startDate

Start date in RFC 3339 standard ('1970-01-01T00:00:00Z'). If the start date is omitted, the default start date is 7 days before the end date.

Type: String
Parameter Sets: (All)
Aliases:

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

-zOrgIdentifier

The ZORG identifier by which to filter the executive summary.

Type: String
Parameter Sets: (All)
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.

INPUTS

OUTPUTS

NOTES

Zerto Analytics REST API Endpoint for Network Site Summary