Resolving Merge Conflicts
This commit is contained in:
Wes Carroll
@@ -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)
|
||||
@@ -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_)
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
@@ -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_)
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
@@ -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_)
|
||||
@@ -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)
|
||||
Reference in New Issue
Block a user