Merge pull request #220 from cohesity/help-docs

enhancement for docs of cmdlets
cohesity · Apr 19, 2023 · ba8d376 · ba8d376
2 parents 6f68222 + 9ee1696
commit ba8d376
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
diff --git a/docs/cmdlets-reference/connect-cohesitycluster.md b/docs/cmdlets-reference/connect-cohesitycluster.md
@@ -53,27 +53,20 @@ Connects to a Cohesity Cluster at the address "192.168.1.100" for a user "user1"
 
 ### EXAMPLE 4
 ```
-Connect-CohesityCluster -Server 192.168.1.100 -Credential (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList "LOCAL\user1@tenant1", (ConvertTo-SecureString -AsPlainText "p@ssword" -Force))
+Connect-CohesityCluster -Server 192.168.1.100 -APIKey "00000000-0000-0000-0000-000000000000"
 ```
 
-Connects to a Cohesity Cluster at the address "192.168.1.100" for a user "user1" in the tenant "tenant1".
+Connects to a Cohesity Cluster at the address "192.168.1.100" using the API Key (supported 6.5.1d onwards).
 
 ### EXAMPLE 5
 ```
-Connect-CohesityCluster -Server 192.168.1.100 -sessionId "sNsZuuvambLmrGO4XASUe+sIxeWpiv8udWXRAxVcOkk="
+Connect-CohesityCluster -Server 192.168.1.100 -sessionId "sessionId"
 ```
 
-Connects to a Cohesity Cluster at the address "192.168.1.100" using the sessionId.
+Connects to a Cohesity Cluster at the address "192.168.1.100" using the Session Id.
 
 ### EXAMPLE 6
 ```
-Connect-CohesityCluster -Server 192.168.1.100 -APIKey "00000000-0000-0000-0000-0000000000000"
-```
-
-Connects to a Cohesity Cluster at the address "192.168.1.100" using the API Key (supported 6.5.1d onwards).
-
-### EXAMPLE 7
-```
 Connect-CohesityCluster -Server 192.168.1.100 -UseMFA -OtpType Email
 ```
 

diff --git a/docs/cmdlets-reference/new-cohesityprotectionjob.md b/docs/cmdlets-reference/new-cohesityprotectionjob.md
@@ -204,7 +204,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: 4/14/2023 5:12:13 PM
+Default value: 4/19/2023 12:34:48 AM
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

diff --git a/docs/cmdlets-reference/new-cohesityuser.md b/docs/cmdlets-reference/new-cohesityuser.md
@@ -143,7 +143,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: 4/14/2023 5:12:14 PM
+Default value: 4/19/2023 12:34:49 AM
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

diff --git a/docs/cmdlets-reference/remove-cohesityviewshare.md b/docs/cmdlets-reference/remove-cohesityviewshare.md
@@ -10,7 +10,7 @@ Remove-CohesityViewShare -ShareName <String> [-WhatIf] [-Confirm] [<CommonParame
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Returns success if the Share is deleted.
 
 ## EXAMPLES
 

diff --git a/src/Cohesity.Powershell/Cmdlets/Cluster/ConnectCohesityCluster.cs b/src/Cohesity.Powershell/Cmdlets/Cluster/ConnectCohesityCluster.cs
@@ -58,6 +58,15 @@ namespace Cohesity.Powershell.Cmdlets.Cluster
     /// <example>
     ///   <para>PS&gt;</para>
     ///   <code>
+    ///   Connect-CohesityCluster -Server 192.168.1.100 -sessionId "sessionId"
+    ///   </code>
+    ///   <para>
+    ///   Connects to a Cohesity Cluster at the address "192.168.1.100" using the Session Id.
+    ///   </para>
+    /// </example>
+    /// <example>
+    ///   <para>PS&gt;</para>
+    ///   <code>
     ///   Connect-CohesityCluster -Server 192.168.1.100 -UseMFA -OtpType Email
     ///   </code>
     ///   <para>