From ff809b733fd7d090df8db17f3428c896816a5605 Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Mon, 10 Jun 2019 07:58:33 -0400 Subject: [PATCH] Correct spelling errors and Add Examples --- .../Public/Get-ZANetworkSiteSummary.ps1 | 2 +- docs/Get-ZANetworkSiteSummary.md | 19 +++++++++++++------ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/ZertoApiWrapper/Public/Get-ZANetworkSiteSummary.ps1 b/ZertoApiWrapper/Public/Get-ZANetworkSiteSummary.ps1 index c797e10..8257ae2 100644 --- a/ZertoApiWrapper/Public/Get-ZANetworkSiteSummary.ps1 +++ b/ZertoApiWrapper/Public/Get-ZANetworkSiteSummary.ps1 @@ -35,7 +35,7 @@ function Get-ZANetworkSiteSummary { [ValidateNotNullOrEmpty()] [string]$endDate, [Parameter( - HelpMessage = "The ZORG identifier by which to filter the excutive summary." + HelpMessage = "The ZORG identifier by which to filter the executive summary." )] [ValidateNotNullOrEmpty()] [string]$zOrgIdentifier diff --git a/docs/Get-ZANetworkSiteSummary.md b/docs/Get-ZANetworkSiteSummary.md index f7f40dc..a3050e9 100644 --- a/docs/Get-ZANetworkSiteSummary.md +++ b/docs/Get-ZANetworkSiteSummary.md @@ -1,7 +1,7 @@ --- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper -online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md +online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZANetworkSiteSummary.md schema: 2.0.0 --- @@ -30,22 +30,29 @@ Get-ZANetworkSiteSummary [-protectedSiteIdentifier ] -recoverySiteIdenti 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, specifiy both the protected site identifier and the recovery 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 ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Get-ZANetworkSiteSummary -protectedSiteIdentifier "7890-1234-5678" ``` -{{ Add example description here }} +Returns outgoing networks summary from site with identifier "7890-1234-5678" + +### Example 2 +```powershell +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 ommitted, the default end date is the current time. +If the end date is omitted, the default end date is the current time. ```yaml Type: String @@ -132,7 +139,7 @@ Accept wildcard characters: False ``` ### -zOrgIdentifier -The ZORG identifier by which to filter the excutive summary. +The ZORG identifier by which to filter the executive summary. ```yaml Type: String