Resolving Merge Conflicts

This commit is contained in:
Wes Carroll
2019-06-06 17:55:01 -04:00
20 changed files with 1218 additions and 5 deletions
+76
View File
@@ -0,0 +1,76 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at technicalmarketing@zerto.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
+19
View File
@@ -0,0 +1,19 @@
#Requires -Modules Pester
$moduleFileName = "ZertoApiWrapper.psd1"
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
$file = Get-ChildItem "$here\$sut"
$modulePath = $here -replace "Public", ""
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
Import-Module $moduleFile -Force
Describe $file.BaseName -Tag 'Unit' {
It "is valid Powershell (Has no script errors)" {
$contents = Get-Content -Path $file -ErrorAction Stop
$errors = $null
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
$errors | Should -HaveCount 0
}
}
+19
View File
@@ -0,0 +1,19 @@
#Requires -Modules Pester
$moduleFileName = "ZertoApiWrapper.psd1"
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
$file = Get-ChildItem "$here\$sut"
$modulePath = $here -replace "Public", ""
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
Import-Module $moduleFile -Force
Describe $file.BaseName -Tag 'Unit' {
It "is valid Powershell (Has no script errors)" {
$contents = Get-Content -Path $file -ErrorAction Stop
$errors = $null
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
$errors | Should -HaveCount 0
}
}
+19
View File
@@ -0,0 +1,19 @@
#Requires -Modules Pester
$moduleFileName = "ZertoApiWrapper.psd1"
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
$file = Get-ChildItem "$here\$sut"
$modulePath = $here -replace "Public", ""
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
Import-Module $moduleFile -Force
Describe $file.BaseName -Tag 'Unit' {
It "is valid Powershell (Has no script errors)" {
$contents = Get-Content -Path $file -ErrorAction Stop
$errors = $null
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
$errors | Should -HaveCount 0
}
}
+6
View File
@@ -89,6 +89,12 @@ task UpdateMarkdownHelp CheckPlatyPSInstalled, {
Update-MarkDownHelp -Path docs -AlphabeticParamsOrder
}
task UpdateMarkdownHelpModule CheckPlatyPSInstalled, {
remove-module ZertoApiWrapper -force -ErrorAction SilentlyContinue
Import-Module .\ZertoApiWrapper\ZertoApiWrapper.psm1 -Force
Update-MarkDownHelpModule -Path docs -AlphabeticParamsOrder
}
task CreatePsd1ForRelease CleanTemp, {
$functionsToExport = Get-ChildItem -Path 'ZertoApiWrapper\Public\*.ps1' | ForEach-Object { $_.BaseName }
$releaseNotes = "# {0}{1}" -f $version, $(Get-Content .\RELEASENOTES.md -Raw)
+6 -5
View File
@@ -15,11 +15,12 @@ function Get-ZAAlert {
[ValidateRange(1, 1000000)]
[int]$limitTo,
[Parameter(
HelpMessage = "The VPG Idnetifier",
ParameterSetName = "vpgId"
HelpMessage = "The alert Idnetifier",
ParameterSetName = "alertId",
Mandatory = $true
)]
[ValidateNotNullOrEmpty()]
[string]$vpgIdentifier
[string]$alertIdentifier
)
$uri = "monitoring/alerts"
switch ($PSCmdlet.ParameterSetName) {
@@ -30,8 +31,8 @@ function Get-ZAAlert {
}
}
vpgId {
$uri = "{0}/{1}" -f $uri, $vpgIdentifier
alertId {
$uri = "{0}/{1}" -f $uri, $alertIdentifier
}
}
Invoke-ZARestRequest -uri $uri
@@ -0,0 +1,37 @@
function Get-ZADatastore {
[CmdletBinding(DefaultParameterSetName = "AllInfo")]
param (
[Parameter(
HelpMessage = "The site identifier. The site identifier is mandatory. Omit the datastore and datastore cluster identifiers to view site level storage information.",
Mandatory = $true,
ParameterSetName = "AllInfo"
)]
[Parameter(
Mandatory = $true,
ParameterSetName = "cluster"
)]
[Parameter(
Mandatory = $true,
ParameterSetName = "datastore"
)]
[ValidateNotNullOrEmpty()]
[string]$siteIdentifier,
[Parameter(
HelpMessage = "The datastore cluster identifier. Gets a list of datastores in the cluster.",
ParameterSetName = "cluster",
Mandatory = "true"
)]
[ValidateNotNullOrEmpty()]
[string]$clusterIdentifier,
[Parameter(
HelpMessage = "The datastore identifer. Gets the datastore info.",
ParameterSetName = "datastore",
Mandatory = $true
)]
[string]$datastoreIdentifier
)
$filter = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "monitoring/datastores{0}" -f $filter
Invoke-ZARestRequest -uri $uri
}
+39
View File
@@ -0,0 +1,39 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZAEvent {
[cmdletbinding()]
param(
[Parameter(
HelpMessage = "The ZORG identifier by which to filter the user's events. If the ZORG identifier is omitted, events is retrieved."
)]
[ValidateNotNullOrEmpty()]
[string]$zOrgIdentifier,
[Parameter(
HelpMessage = "The event category (events/alertsHistory). Default displays the list of all."
)]
[ValidateSet("events", "alertsHistory")]
[string]$category,
[Parameter(
HelpMessage = "The maximum number of events to return."
)]
[ValidateRange(1, 1000000)]
[int]$limitTo,
[Parameter(
HelpMessage = "The earliest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z'). Default is one year ago."
)]
[ValidateNotNullOrEmpty()]
[string]$startDate,
[Parameter(
HelpMessage = "The latest timestamp of an event to return, in RFC 3339 standard ('1970-01-01T00:00:00Z'). Default is the present time."
)]
[ValidateNotNullOrEmpty()]
[string]$endDate
)
$uri = "monitoring/events"
if ( $PSBoundParameters.Keys.Count -gt 0 ) {
$filterString = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "{0}{1}" -f $uri, $filterString
}
Invoke-ZARestRequest -uri $uri
}
+39
View File
@@ -0,0 +1,39 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZATask {
[cmdletbinding( DefaultParameterSetName = "zOrg")]
param(
[Parameter(
HelpMessage = "The ZORG identifier by which to filter the task list. If the ZORG identifier is omitted, a list of all the tasks is retrieved.",
ParameterSetName = "zOrg"
)]
[ValidateNotNullOrEmpty()]
[string]$zOrgIdentifier,
[Parameter(
HelpMessage = "The maximum number of tasks to return.",
ParameterSetName = "zOrg"
)]
[ValidateRange(1, 1000000)]
[int]$limitTo,
[Parameter(
HelpMessage = "The task Idnetifier",
ParameterSetName = "taskId",
Mandatory = $true
)]
[ValidateNotNullOrEmpty()]
[string]$taskIdentifier
)
$uri = "monitoring/tasks"
switch ($PSCmdlet.ParameterSetName) {
zOrg {
if ( $PSBoundParameters.Keys.Count -gt 0 ) {
$filterString = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "{0}{1}" -f $uri, $filterString
}
}
taskId {
$uri = "{0}/{1}" -f $uri, $taskIdentifier
}
}
Invoke-ZARestRequest -uri $uri
}
+61
View File
@@ -0,0 +1,61 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Connect-ZertoAnalytics.md
schema: 2.0.0
---
# Connect-ZertoAnalytics
## SYNOPSIS
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password).
## SYNTAX
```
Connect-ZertoAnalytics [-credential] <PSCredential> [<CommonParameters>]
```
## DESCRIPTION
All requests to the server, apart from the request to authenticate, must contain a security token which is provided on successful authentication.
In order to authenticate, the user sends myZerto credentials (user/password). Once this call has been completed successfully, the header authentication token will be stored as a variable and automatically passed during future calls to the Zerto Analytics platform. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## EXAMPLES
### Example 1
```powershell
PS C:\> Connect-ZertoAnalytics -credential $myCredential
```
Connects to the Zerto Analytics site and gets a Bearer Authorization token that is automatically stored as a variable for future calls to the Zerto Analytics REST API. This token will automatically expire after 60 minutes of inactivity and need to be reauthorized by calling this function again.
## PARAMETERS
### -credential
PSCredential Object containing username and password authorized for the Zerto Analytics site
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
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
[Zerto Analytics REST API Endpoint for Authentication](https://docs.api.zerto.com/#/Authentication/post_v2_auth_token)
+125
View File
@@ -0,0 +1,125 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAAlert.md
schema: 2.0.0
---
# Get-ZAAlert
## SYNOPSIS
Retrieve information about all existing alerts.
## SYNTAX
### zOrg (Default)
```
Get-ZAAlert [-zOrgIdentifier <String>] [-limitTo <Int32>] [<CommonParameters>]
```
### alertId
```
Get-ZAAlert -alertIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Retrieve information about all existing alerts.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAAlert
```
Returns all alerts.
### Example 2
```powershell
PS C:\> Get-ZAAlert -limitTo 10
```
Returns 10 alerts.
### Example 3
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012"
```
Returns all alerts for the zOrg with Identifier "1234-5678-9012".
### Example 4
```powershell
PS C:\> Get-ZAAlert -zOrgIdentifier "1234-5678-9012" -limitTo 10
```
Returns 10 alerts for the zOrg with Identifier "1234-5678-9012".
### Example 3
```powershell
PS C:\> Get-ZAAlert -alertId "1234-5678-9012"
```
Returns one alert with identifier "1234-5678-9012".
## PARAMETERS
### -alertIdentifier
The VPG Idnetifier
```yaml
Type: String
Parameter Sets: alertId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of alerts to return.
```yaml
Type: Int32
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the alert list.
If the ZORG identifier is omitted, a list of all the alerts is retrieved.
```yaml
Type: String
Parameter Sets: zOrg
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Alerts](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts)
[Zerto Analytics REST API Endpoint for Alerts by Identifier](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_alerts__alertIdentifier_)
+123
View File
@@ -0,0 +1,123 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZATask.md
schema: 2.0.0
---
# Get-ZADatastore
## SYNOPSIS
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## SYNTAX
### AllInfo (Default)
```
Get-ZADatastore -siteIdentifier <String> [<CommonParameters>]
```
### datastore
```
Get-ZADatastore -siteIdentifier <String> -datastoreIdentifier <String> [<CommonParameters>]
```
### cluster
```
Get-ZADatastore -siteIdentifier <String> -clusterIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Get a list of datastore/s, filtered by site. Enter a site identifier only to get the list of all datastores. Enter a site identifier and cluster identifier to get a list of datastores in the cluster. Enter a site identifier and datastore identifier to get specific datastore info.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678"
```
Returns all datastore clusters and datastores associated with site identifier "7890-1234-5678"
### Example 2
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -clusterIdentifier "3456-7890-1234"
```
Returns datastore cluster information with identifier "3456-7890-1234" associated with site identifier "7890-1234-5678"
### Example 3
```powershell
PS C:\> Get-ZADatastore -siteIdentifier "7890-1234-5678" -datastoreIdentifier "5678-9012-3456"
```
Returns all datastore information with identifier "5678-9012-3456" associated with site identifier "7890-1234-5678"
## PARAMETERS
### -clusterIdentifier
The datastore cluster identifier.
Gets a list of datastores in the cluster.
```yaml
Type: String
Parameter Sets: cluster
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -datastoreIdentifier
The datastore identifer.
Gets the datastore info.
```yaml
Type: String
Parameter Sets: datastore
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
The site identifier.
The site identifier is mandatory.
Omit the datastore and datastore cluster identifiers to view site level storage information.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Datastores](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_datastores)
+140
View File
@@ -0,0 +1,140 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAEvent.md
schema: 2.0.0
---
# Get-ZAEvent
## SYNOPSIS
Retrieve details of all existing events.
## SYNTAX
```
Get-ZAEvent [[-zOrgIdentifier] <String>] [[-category] <String>] [[-limitTo] <Int32>] [[-startDate] <String>]
[[-endDate] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve details of all existing events.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAEvent
```
Retrieve details of all existing events.
### Example 2
```powershell
PS C:\> Get-ZAEvent -zOrgIdentifier "1234-5678-9012"
```
Retrieve details of all existing events for zOrg with Identifier "1234-5678-9012"
### Example 3
```powershell
PS C:\> Get-ZAEvent -category events -startDate "2019-03-01" -endDate "2019-04-01" -limitTo 400
```
Retrieve details of all events between March 1st and April 1st and limit results to 400.
## PARAMETERS
### -category
The event category (events/alertsHistory).
Default displays the list of all.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
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').
Default is the present time.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -limitTo
The maximum number of events to return.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
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').
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
```
### -zOrgIdentifier
The ZORG identifier by which to filter the user's events.
If the ZORG identifier is omitted, events is retrieved.
```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
[Zerto Analytics REST API Endpoint for Events](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_events)
+45
View File
@@ -0,0 +1,45 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZALicense.md
schema: 2.0.0
---
# Get-ZALicense
## SYNOPSIS
Retrieve a list of all licenses.
## SYNTAX
```
Get-ZALicense [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all licenses.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZALicense
```
Returns all licenses and associated information
## PARAMETERS
### 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
[Zerto Analytics REST API License End Point Documentation](https://docs.api.zerto.com/#/Licenses/get_v2_licenses)
+69
View File
@@ -0,0 +1,69 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAMonitoring.md
schema: 2.0.0
---
# Get-ZAMonitoring
## SYNOPSIS
Retrieve statistics related to all the user's sites - belonging to a single account.
## SYNTAX
```
Get-ZAMonitoring [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve statistics related to all the user's sites - belonging to a single account.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAMonitoring
```
Retrieve statistics related to all the user's sites - belonging to a single account.
### Example 1
```powershell
PS C:\> Get-ZAMonitoring -zOrgIdentifier "1234-5678-9012"
```
Retrieve statistics related to the zOrgIdentifier provided
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter the user's statistics for a single account.
If the ZORG identifier is omitted, statistics related to all sites, for a single account, is retrieved.
```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
[Zerto Analytics REST API Endpoint for Monitoring](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_)
+69
View File
@@ -0,0 +1,69 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASite.md
schema: 2.0.0
---
# Get-ZASite
## SYNOPSIS
Retrieve a list of all sites.
## SYNTAX
```
Get-ZASite [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all sites.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASite
```
Retrieve a list of all sites.
### Example 2
```powershell
PS C:\> Get-ZASite -zOrgIdentifier "1234-5678-9012"
```
Retrieve a list of all sites managed under zOrgIdentifier "1234-5678-9012".
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter site list.
If the ZORG identifier is omitted, a list of all sites is retrieved.
```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
[Zerto Analytics REST API Endpoint for Sites](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_sites)
+70
View File
@@ -0,0 +1,70 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZASiteTopology.md
schema: 2.0.0
---
# Get-ZASiteTopology
## SYNOPSIS
Retrieves a collection of Sites topology information structures for all the available user's sites, including disabled and non-transmitting due to lack of a transmitter (older ZVR versions).
## SYNTAX
```
Get-ZASiteTopology [[-zOrgIdentifier] <String>] [<CommonParameters>]
```
## DESCRIPTION
Retrieves a collection of Sites topology information structures for all the available user's sites, including disabled and non-transmitting due to lack of a transmitter (older ZVR versions). | The following note should be taken into consideration:
The information might not be complete, since there are sites that do not transmit (disabled), yet this API concludes their presence and VPG count from the VPGs they share with transmitting sites. Such a disabled site might have relations with other disabled sites, which this API does not reveal.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZASiteTopology
```
Retrieves a collection of Sites topology information structures for all the available user's sites.
### Example 2
```powershell
PS C:\> Get-ZASiteTopology -zOrgIdentifier "1234-5678-9012"
```
Retrieves a collection of Sites topology information structures for all the available user's sites within zOrgIdentifier "1234-5678-9012".
## PARAMETERS
### -zOrgIdentifier
The ZORG identifier by which to filter sites topology list.
If the ZORG identifier is omitted, information related to all sites topology is retrieved.
```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
[Zerto Analytics REST API Endpoint for Site Topology](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_sites_format_topology)
+112
View File
@@ -0,0 +1,112 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZATask.md
schema: 2.0.0
---
# Get-ZATask
## SYNOPSIS
Retrieve details of all existing tasks.
## SYNTAX
### zOrg (Default)
```
Get-ZATask [-zOrgIdentifier <String>] [-limitTo <Int32>] [<CommonParameters>]
```
### taskId
```
Get-ZATask -taskIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Retrieve details of all existing tasks.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZATask
```
Retrieve details of all existing tasks.
### Example 2
```powershell
PS C:\> Get-ZATask -zOrgIdentifier "1234-5678-9012"
```
Retrieve details of all existing tasks for zOrg with Identifier "1234-5678-9012".
### Example 1
```powershell
PS C:\> Get-ZATask -taskIdentifier "9012-3456-7890"
```
Retrieve details of a specific task with identifier "9012-3456-7890".
## PARAMETERS
### -limitTo
The maximum number of tasks to return.
```yaml
Type: Int32
Parameter Sets: zOrg
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -taskIdentifier
The task Idnetifier
```yaml
Type: String
Parameter Sets: taskId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the task list.
If the ZORG identifier is omitted, a list of all the tasks is retrieved.
```yaml
Type: String
Parameter Sets: zOrg
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for Tasks](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_tasks)
+98
View File
@@ -0,0 +1,98 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAVpg.md
schema: 2.0.0
---
# Get-ZAVpg
## SYNOPSIS
Retrieve a list of all VPGs.
## SYNTAX
### zOrg (Default)
```
Get-ZAVpg [-zOrgIdentifier <String>] [<CommonParameters>]
```
### vpg
```
Get-ZAVpg -vpgIdentifier <String> [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all VPGs.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAVpg
```
Retrieve a list of all VPGs.
### Example 2
```powershell
PS C:\> Get-ZAVpg -zOrgIdentifier "1234-5678-9012"
```
Retrieve a list of all VPGs associated with zOrg "1234-5678-9012"
### Example 3
```powershell
PS C:\> Get-ZAVpg -vpgIdentifier "2109-8765-4321"
```
Retrieve information for VPG with identifier "2109-8765-4321"
## PARAMETERS
### -vpgIdentifier
The VPG Identifier
```yaml
Type: String
Parameter Sets: vpg
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zOrgIdentifier
The ZORG identifier by which to filter the VPG list.
If the ZORG identifier is omitted, a list of all VPGs is retrieved.
```yaml
Type: String
Parameter Sets: zOrg
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
[Zerto Analytics REST API Endpoint for VPGs](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_vpgs)
[Zerto Analytics REST API Endpoint for VPG Identifier](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_vpgs__vpgIdentifier_)
+46
View File
@@ -0,0 +1,46 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAzOrg.md
schema: 2.0.0
---
# Get-ZAzOrg
## SYNOPSIS
Retrieve a list of all ZORGs.
## SYNTAX
```
Get-ZAzOrg [<CommonParameters>]
```
## DESCRIPTION
Retrieve a list of all ZORGs.
## EXAMPLES
### Example 1
```powershell
PS C:\> Get-ZAzOrg
```
Retrieve a list of all ZORGs.
## PARAMETERS
### 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
[Zerto Analytics REST API Endpoint for ZOrgs](https://docs.api.zerto.com/#/Monitoring/get_v2_monitoring_zorgs)