Correct spelling errors and Add Examples

This commit is contained in:
Wes Carroll
2019-06-10 07:58:33 -04:00
parent 9a2e1c63ad
commit ff809b733f
2 changed files with 14 additions and 7 deletions
@@ -35,7 +35,7 @@ function Get-ZANetworkSiteSummary {
[ValidateNotNullOrEmpty()] [ValidateNotNullOrEmpty()]
[string]$endDate, [string]$endDate,
[Parameter( [Parameter(
HelpMessage = "The ZORG identifier by which to filter the excutive summary." HelpMessage = "The ZORG identifier by which to filter the executive summary."
)] )]
[ValidateNotNullOrEmpty()] [ValidateNotNullOrEmpty()]
[string]$zOrgIdentifier [string]$zOrgIdentifier
+13 -6
View File
@@ -1,7 +1,7 @@
--- ---
external help file: ZertoApiWrapper-help.xml external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper 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 schema: 2.0.0
--- ---
@@ -30,22 +30,29 @@ Get-ZANetworkSiteSummary [-protectedSiteIdentifier <String>] -recoverySiteIdenti
Get a network executive summary for sites, filtered by start date and end date.The following options are available: 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 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 ## EXAMPLES
### Example 1 ### Example 1
```powershell ```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 ## PARAMETERS
### -endDate ### -endDate
End date in RFC 3339 standard ('1970-01-01T00:00:00Z'). 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 ```yaml
Type: String Type: String
@@ -132,7 +139,7 @@ Accept wildcard characters: False
``` ```
### -zOrgIdentifier ### -zOrgIdentifier
The ZORG identifier by which to filter the excutive summary. The ZORG identifier by which to filter the executive summary.
```yaml ```yaml
Type: String Type: String