Create new function help files

Export-ZertoVpg, Import-ZertoVpg, New-ZertoVpgSettingsIdentifier
This commit is contained in:
Wes Carroll
2019-03-14 20:42:24 -04:00
parent 941d25a588
commit 185cb8a360
3 changed files with 239 additions and 0 deletions
+96
View File
@@ -0,0 +1,96 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version:
schema: 2.0.0
---
# Export-ZertoVpg
## SYNOPSIS
{{ Fill in the Synopsis }}
## SYNTAX
### namedVpgs
```
Export-ZertoVpg -outputFolder <String> [-vpgName <String[]>] [<CommonParameters>]
```
### allVpgs
```
Export-ZertoVpg -outputFolder <String> [-allVpgs] [<CommonParameters>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### Example 1
```powershell
PS C:> {{ Add example code here }}
```
{{ Add example description here }}
## PARAMETERS
### -allVpgs
Export all VPGs at this site
```yaml
Type: SwitchParameter
Parameter Sets: allVpgs
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -outputFolder
Location where to dump the resulting JSON files containing the VPG Settings
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgName
Name(s) of the VPG(s) to be exported
```yaml
Type: String[]
Parameter Sets: namedVpgs
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
### System.Management.Automation.SwitchParameter
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
+60
View File
@@ -0,0 +1,60 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version:
schema: 2.0.0
---
# Import-ZertoVpg
## SYNOPSIS
{{ Fill in the Synopsis }}
## SYNTAX
```
Import-ZertoVpg [-settingsFile] <String[]> [<CommonParameters>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### Example 1
```powershell
PS C:> {{ Add example code here }}
```
{{ Add example description here }}
## PARAMETERS
### -settingsFile
VPG settings JSON file(s) to import.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases: FullName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
### System.String[]
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
+83
View File
@@ -0,0 +1,83 @@
---
external help file: ZertoApiWrapper-help.xml
Module Name: ZertoApiWrapper
online version:
schema: 2.0.0
---
# New-ZertoVpgSettingsIdentifier
## SYNOPSIS
{{ Fill in the Synopsis }}
## SYNTAX
### existingVpg
```
New-ZertoVpgSettingsIdentifier -vpgIdentifier <String> [<CommonParameters>]
```
### newVpg
```
New-ZertoVpgSettingsIdentifier [-newVpg] [<CommonParameters>]
```
## DESCRIPTION
{{ Fill in the Description }}
## EXAMPLES
### Example 1
```powershell
PS C:> {{ Add example code here }}
```
{{ Add example description here }}
## PARAMETERS
### -newVpg
Use this switch when creating a vpgSettingsIdentifier for a new VPG
```yaml
Type: SwitchParameter
Parameter Sets: newVpg
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
Identifier of the VPG to create a VPG settings identifier.
If a vpgIdentifier is not provided, a new VPG settings object is created without any configured settings.
This would be used for creating a new VPG from scratch.
```yaml
Type: String
Parameter Sets: existingVpg
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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
### System.String
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS