Update Help for AutoReconnect switch
This commit is contained in:
Wes Carroll
+135
-112
@@ -1,112 +1,135 @@
|
|||||||
---
|
---
|
||||||
external help file: ZertoApiWrapper-help.xml
|
external help file: ZertoApiWrapper-help.xml
|
||||||
Module Name: ZertoApiWrapper
|
Module Name: ZertoApiWrapper
|
||||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Connect-ZertoServer.md
|
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Connect-ZertoServer.md
|
||||||
schema: 2.0.0
|
schema: 2.0.0
|
||||||
---
|
---
|
||||||
|
|
||||||
# Connect-ZertoServer
|
# Connect-ZertoServer
|
||||||
|
|
||||||
## SYNOPSIS
|
## SYNOPSIS
|
||||||
Establishes a connection to a ZVM.
|
Establishes a connection to a ZVM.
|
||||||
|
|
||||||
## SYNTAX
|
## SYNTAX
|
||||||
|
|
||||||
```
|
```
|
||||||
Connect-ZertoServer [-zertoServer] <String> [[-zertoPort] <String>] [-credential] <PSCredential>
|
Connect-ZertoServer [-zertoServer] <String> [[-zertoPort] <String>] [-credential] <PSCredential>
|
||||||
[-returnHeaders] [<CommonParameters>]
|
[-returnHeaders] [-AutoReconnect] [<CommonParameters>]
|
||||||
```
|
```
|
||||||
|
|
||||||
## DESCRIPTION
|
## DESCRIPTION
|
||||||
Establishes a connection to a ZVM using credentials provided via a PSCredential Object leveraging the Zerto Session API end point.
|
Establishes a connection to a ZVM using credentials provided via a PSCredential Object leveraging the Zerto Session API end point.
|
||||||
|
|
||||||
## EXAMPLES
|
## EXAMPLES
|
||||||
|
|
||||||
### Example 1
|
### Example 1
|
||||||
```powershell
|
```powershell
|
||||||
PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -credential $credential
|
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.
|
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object.
|
||||||
|
|
||||||
## PARAMETERS
|
### Example 2
|
||||||
|
```powershell
|
||||||
### -credential
|
PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -credential $credential -AutoReconnect
|
||||||
Valid credentials to connect to the Zerto Management Server
|
```
|
||||||
|
|
||||||
```yaml
|
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object. Adding the `-AutoReconnect` switch
|
||||||
Type: PSCredential
|
will cache the PSCredential object should the session need to be reauthorized due to an expired token.
|
||||||
Parameter Sets: (All)
|
|
||||||
Aliases:
|
## PARAMETERS
|
||||||
|
|
||||||
Required: True
|
### -AutoReconnect
|
||||||
Position: 2
|
Use this switch to indicate that you would like the module to take care of auto re-authorization and reconnection to the ZVM should the token expire. This option will cache your PSCredential object to be reused
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
```yaml
|
||||||
Accept wildcard characters: False
|
Type: SwitchParameter
|
||||||
```
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
### -returnHeaders
|
|
||||||
Use this switch to return the headers to a specified variable or to the default output.
|
Required: False
|
||||||
|
Position: Named
|
||||||
```yaml
|
Default value: None
|
||||||
Type: SwitchParameter
|
Accept pipeline input: False
|
||||||
Parameter Sets: (All)
|
Accept wildcard characters: False
|
||||||
Aliases:
|
```
|
||||||
|
|
||||||
Required: False
|
### -credential
|
||||||
Position: Named
|
Valid credentials to connect to the Zerto Management Server
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
```yaml
|
||||||
Accept wildcard characters: False
|
Type: PSCredential
|
||||||
```
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
### -zertoPort
|
|
||||||
Zerto Virtual Manager management port.
|
Required: True
|
||||||
Default value is 9669.
|
Position: 2
|
||||||
|
Default value: None
|
||||||
```yaml
|
Accept pipeline input: False
|
||||||
Type: String
|
Accept wildcard characters: False
|
||||||
Parameter Sets: (All)
|
```
|
||||||
Aliases: port
|
|
||||||
|
### -returnHeaders
|
||||||
Required: False
|
Use this switch to return the headers to a specified variable or to the default output.
|
||||||
Position: 1
|
|
||||||
Default value: "9669"
|
```yaml
|
||||||
Accept pipeline input: False
|
Type: SwitchParameter
|
||||||
Accept wildcard characters: False
|
Parameter Sets: (All)
|
||||||
```
|
Aliases:
|
||||||
|
|
||||||
### -zertoServer
|
Required: False
|
||||||
IP address or FQDN of your Zerto Management Server
|
Position: Named
|
||||||
|
Default value: None
|
||||||
```yaml
|
Accept pipeline input: False
|
||||||
Type: String
|
Accept wildcard characters: False
|
||||||
Parameter Sets: (All)
|
```
|
||||||
Aliases: server, zvm
|
|
||||||
|
### -zertoPort
|
||||||
Required: True
|
Zerto Virtual Manager management port.
|
||||||
Position: 0
|
Default value is 9669.
|
||||||
Default value: None
|
|
||||||
Accept pipeline input: False
|
```yaml
|
||||||
Accept wildcard characters: False
|
Type: String
|
||||||
```
|
Parameter Sets: (All)
|
||||||
|
Aliases: port
|
||||||
### 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).
|
Required: False
|
||||||
|
Position: 1
|
||||||
## INPUTS
|
Default value: "9669"
|
||||||
|
Accept pipeline input: False
|
||||||
### None
|
Accept wildcard characters: False
|
||||||
## OUTPUTS
|
```
|
||||||
|
|
||||||
### System.Object
|
### -zertoServer
|
||||||
## NOTES
|
IP address or FQDN of your Zerto Management Server
|
||||||
|
|
||||||
## RELATED LINKS
|
```yaml
|
||||||
|
Type: String
|
||||||
[Zerto REST API Session End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.068.html%23)
|
Parameter Sets: (All)
|
||||||
|
Aliases: server, zvm
|
||||||
[PSCredential Documentation](https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.pscredential?view=pscore-6.0.0)
|
|
||||||
|
Required: True
|
||||||
[Get-Credential Documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6)
|
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](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.068.html%23)
|
||||||
|
|
||||||
|
[PSCredential Documentation](https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.pscredential?view=pscore-6.0.0)
|
||||||
|
|
||||||
|
[Get-Credential Documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6)
|
||||||
|
|||||||
Reference in New Issue
Block a user