zerto/ZertoApiWrapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Help for AutoReconnect switch

Browse Source
This commit is contained in:
Wes Carroll
2020-06-11 14:19:20 -04:00
parent 3000a2b013
commit 348fcbd28c
1 changed files with 135 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Connect-ZertoServer.md
+24 -1
View File
@@ -14,7 +14,7 @@ Establishes a connection to a ZVM.
```
Connect-ZertoServer [-zertoServer] <String> [[-zertoPort] <String>] [-credential] <PSCredential>
[-returnHeaders] [<CommonParameters>]
[-returnHeaders] [-AutoReconnect] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,8 +29,31 @@ PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -cred
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object.
### Example 2
```powershell
PS C:\> Connect-ZertoServer -zertoServer "192.168.1.100" -zertoPort "9669" -credential $credential -AutoReconnect
```
Establishes a connection to ZVM 192.168.1.100 on port 9669 with supplied PSCredential object. Adding the `-AutoReconnect` switch
will cache the PSCredential object should the session need to be reauthorized due to an expired token.
## PARAMETERS
### -AutoReconnect
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
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -credential
Valid credentials to connect to the Zerto Management Server