Help system (#4)

* Establish a help system

* Continue to update Help System

* Update Get-ZertoAlert.md

* Update Get-ZertoDatastore.md

* Add Link to Zerto API for Datastores

* Update Get-ZertoLicense.md

* Update Links to Zerto API documentation

* Update the Readme Information

* Continue to update README

* Update README

* Update README.md

* Update Help Markdown Files

* Correct API URL

* Update ZertoApiWrapper-help.xml

* Update Get-ZertoProtectedVm.md

* Update Help Markdown files

* Update Get-ZertoVpgSetting.md

* Added online url to each help object.

* Update Help Markdown Files

* Update ZertoApiWrapper-help.xml
This commit is contained in:
Wes Carroll
2019-03-06 20:50:14 -05:00
committed by GitHub
parent 8521bec5a8
commit 59a0a53812
86 changed files with 15514 additions and 4 deletions
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Add-ZertoPeerSite {
[cmdletbinding( SupportsShouldProcess = $true )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Checkpoint-ZertoVpg {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Connect-ZertoServer {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Disconnect-ZertoServer {
[cmdletbinding()]
$uri = "session"
+1
View File
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Edit-ZertoVra {
[cmdletbinding( SupportsShouldProcess = $true )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoAlert {
[cmdletbinding( defaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoDatastore {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoEvent {
[cmdletbinding( defaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoLicense {
[cmdletbinding()]
$uri = "license"
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoLocalSite {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoPeerSite {
[cmdletbinding( defaultParameterSetName = "main" )]
param (
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoProtectedVm {
[cmdletbinding( DefaultParameterSetName = "main" )]
param (
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoRecoveryReport {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoResourcesReport {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoServiceProfile {
[cmdletbinding( DefaultParameterSetName = "main" )]
param (
+1
View File
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoTask {
[cmdletbinding( DefaultParameterSetName = "main" )]
param (
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoUnprotectedVm {
[cmdletbinding()]
$uri = "virtualizationsites/{0}/vms" -f $(Get-ZertoLocalSite).siteidentifier
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoVirtualizationSite {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoVolume {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
+1
View File
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoVpg {
[cmdletbinding( DefaultParameterSetName = "main" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoVpgSetting {
[cmdletbinding(
DefaultParameterSetName = "main",
+2 -1
View File
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoVra {
[cmdletbinding(
DefaultParameterSetName = "main"
@@ -82,7 +83,7 @@ function Get-ZertoVra {
}
# When vra ids are provided, return for each id provided
"vraIdentifier" {
"vraIdentifierifierifier" {
$returnObject = foreach ( $vraId in $vraIdentifier ) {
$uri = "{0}/{1}" -f $baseUri, $vraId
Invoke-ZertoRestRequest -uri $uri
+1
View File
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoZorg {
[cmdletbinding( DefaultParameterSetName = "default" )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Get-ZertoZsspSession {
[cmdletbinding( DefaultParameterSetName = "default" )]
param(
@@ -1,4 +1,5 @@
#TODO - Add ability to installed with root password.
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Install-ZertoVra {
[cmdletbinding( SupportsShouldProcess = $true )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoFailover {
[cmdletbinding()]
param(
@@ -1,5 +1,6 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoFailoverCommit {
[cmdletbiding()]
[cmdletbinding()]
param(
[Parameter(
HelpMessage = "Name(s) of the VPG(s) to commit.",
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoFailoverRollback {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoForceSync {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoMove {
[CmdletBinding()]
param(
@@ -1,5 +1,6 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoMoveCommit {
[cmdletbiding()]
[cmdletbinding()]
param(
[Parameter(
HelpMessage = "Name(s) of the VPG(s) to commit.",
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Invoke-ZertoMoveRollback {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Remove-ZertoVpg {
[cmdletbinding( SupportsShouldProcess = $true )]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Resume-ZertoVpg {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Set-ZertoAlert {
[cmdletbinding( SupportsShouldProcess = $true )]
param (
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Set-ZertoLicense {
[cmdletbinding( SupportsShouldProcess = $true )]
param (
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Start-ZertoCloneVpg {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Start-ZertoFailoverTest {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Stop-ZertoCloneVpg {
param(
[Parameter(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Stop-ZertoFailoverTest {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Suspend-ZertoVpg {
[cmdletbinding()]
param(
@@ -1,3 +1,4 @@
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
function Uninstall-ZertoVra {
[cmdletbinding()]
param(
File diff suppressed because it is too large Load Diff