Wes Carroll
59a0a53812
* 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
2.8 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| ZertoApiWrapper-help.xml | ZertoApiWrapper | https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Connect-ZertoServer.md | 2.0.0 |
Connect-ZertoServer
SYNOPSIS
Establishes a connection to a ZVM.
SYNTAX
Connect-ZertoServer [-zertoServer] <String> [[-zertoPort] <String>] [-credential] <PSCredential>
[-returnHeaders] [<CommonParameters>]
DESCRIPTION
Establishes a connection to a ZVM using credentials provided via a PSCredential Object leveraging the Zerto Session API end point.
EXAMPLES
Example 1
PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -credential $credential
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object.
PARAMETERS
-credential
Valid credentials to connect to the Zerto Management Server
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-returnHeaders
Use this switch to return the headers to a specified variable or to the default output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-zertoPort
Zerto Virtual Manager management port. Default value is 9669.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: "9669"
Accept pipeline input: False
Accept wildcard characters: False
-zertoServer
IP address or FQDN of your Zerto Management Server
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
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 REST API Session End Point Documentation PSCredential Documentation Get-Credential Documentation