From 8bd865d83d9e59aa9a6117983406bd0d54f58bda Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Sun, 8 Mar 2020 22:45:51 -0400 Subject: [PATCH] Create Template Help Files --- docs/Get-ZAPlannerJournalSizeReport.md | 139 +++++++++++++++++ docs/Get-ZAPlannerNetworkPerformanceReport.md | 140 ++++++++++++++++++ docs/Get-ZAPlannerSite.md | 57 +++++++ docs/Get-ZAPlannerStatsReport.md | 139 +++++++++++++++++ docs/Get-ZAPlannerWanReport.md | 122 +++++++++++++++ docs/Get-ZAPlannerZcasReport.md | 122 +++++++++++++++ 6 files changed, 719 insertions(+) create mode 100644 docs/Get-ZAPlannerJournalSizeReport.md create mode 100644 docs/Get-ZAPlannerNetworkPerformanceReport.md create mode 100644 docs/Get-ZAPlannerSite.md create mode 100644 docs/Get-ZAPlannerStatsReport.md create mode 100644 docs/Get-ZAPlannerWanReport.md create mode 100644 docs/Get-ZAPlannerZcasReport.md diff --git a/docs/Get-ZAPlannerJournalSizeReport.md b/docs/Get-ZAPlannerJournalSizeReport.md new file mode 100644 index 0000000..3579885 --- /dev/null +++ b/docs/Get-ZAPlannerJournalSizeReport.md @@ -0,0 +1,139 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerJournalSizeReport + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerJournalSizeReport [-siteIdentifier] [-recoveryType] [-vmIdentifier] + [[-desiredJournalHistory] ] [[-startDate] ] [[-endDate] ] [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -desiredJournalHistory +The desired journal history in hours. +The default is 24 hours. +Limited to a 1 hour up to 720 hours, or the equivalent of 30 days + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 24 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -endDate +The latest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is the current time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -recoveryType +Type of target recovery site. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -startDate +The earliest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is one year ago. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmIdentifier +Identifiers of the VMs you want to recover at the target recovery site. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-ZAPlannerNetworkPerformanceReport.md b/docs/Get-ZAPlannerNetworkPerformanceReport.md new file mode 100644 index 0000000..5dd4498 --- /dev/null +++ b/docs/Get-ZAPlannerNetworkPerformanceReport.md @@ -0,0 +1,140 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerNetworkPerformanceReport + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerNetworkPerformanceReport [-siteIdentifier] [-recoveryType] + [-vmIdentifier] [[-interval] ] [[-startDate] ] [[-endDate] ] + [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -endDate +The latest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is the current time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -interval +The desired sample interval in seconds. +The default is 3600 seconds (1 Hour). +Limited to a 60 second to 86,400 second (24 Hour) interval + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 3600 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -recoveryType +Type of target recovery site. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -startDate +The earliest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is one year ago. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmIdentifier +Identifiers of the VMs you want to recover at the target recovery site. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-ZAPlannerSite.md b/docs/Get-ZAPlannerSite.md new file mode 100644 index 0000000..986ee4e --- /dev/null +++ b/docs/Get-ZAPlannerSite.md @@ -0,0 +1,57 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerSite + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerSite [[-siteIdentifier] ] [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-ZAPlannerStatsReport.md b/docs/Get-ZAPlannerStatsReport.md new file mode 100644 index 0000000..63195d2 --- /dev/null +++ b/docs/Get-ZAPlannerStatsReport.md @@ -0,0 +1,139 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerStatsReport + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerStatsReport [-siteIdentifier] [-recoveryType] [-vmIdentifier] + [[-desiredJournalHistory] ] [[-startDate] ] [[-endDate] ] [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -desiredJournalHistory +The desired journal history in hours. +The default is 24 hours. +Limited to a 1 hour up to 720 hours, or the equivalent of 30 days + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 24 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -endDate +The latest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is the current time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -recoveryType +Type of target recovery site. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -startDate +The earliest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is one year ago. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmIdentifier +Identifiers of the VMs you want to recover at the target recovery site. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-ZAPlannerWanReport.md b/docs/Get-ZAPlannerWanReport.md new file mode 100644 index 0000000..e4c48c0 --- /dev/null +++ b/docs/Get-ZAPlannerWanReport.md @@ -0,0 +1,122 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerWanReport + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerWanReport [-siteIdentifier] [-recoveryType] [-vmIdentifier] + [[-startDate] ] [[-endDate] ] [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -endDate +The latest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is the current time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -recoveryType +Type of target recovery site. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -startDate +The earliest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is one year ago. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmIdentifier +Identifiers of the VMs you want to recover at the target recovery site. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-ZAPlannerZcasReport.md b/docs/Get-ZAPlannerZcasReport.md new file mode 100644 index 0000000..9dd5bd5 --- /dev/null +++ b/docs/Get-ZAPlannerZcasReport.md @@ -0,0 +1,122 @@ +--- +external help file: ZertoApiWrapper-help.xml +Module Name: ZertoApiWrapper +online version: +schema: 2.0.0 +--- + +# Get-ZAPlannerZcasReport + +## SYNOPSIS + +## SYNTAX + +``` +Get-ZAPlannerZcasReport [-siteIdentifier] [-recoveryType] [-vmIdentifier] + [[-startDate] ] [[-endDate] ] [] +``` + +## DESCRIPTION +{{Fill in the Description}} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -endDate +The latest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is the current time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -recoveryType +Type of target recovery site. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -siteIdentifier +The site identifier(s) for which to return detailed information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -startDate +The earliest timestamp of an event to return, in RFC 3339 standard. +('1970-01-01T00:00:00Z'). +The default is one year ago. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmIdentifier +Identifiers of the VMs you want to recover at the target recovery site. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +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 (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS