Post Installation

Verifying Installation

To verify the installation of the Cisco HX Connect PowerShell Tool Kit (PSTK), enter the following cmdlet:

get-module -name Cisco.HXPowerCLI
Sample Output:
 ModuleType    Version      Name              ExportedCommands
------------   ---------    ---------------   ---------------------------
 Binary        1.0          Cisco.Runbook     {Add-HXProtectedVMToGroup, 
                                               Connect-HXCluster, 
                                               Disconnect-HXCluster, 
                                               Get-HXCluster...}   

Viewing Available cmdlets

To view a list of all available Cisco HXPowerCLI cmdlets run the command:

Get-Command -Module Cisco.HXPowerCLI
Sample Output:
CommandType     Name                                  Version    Source                                                                                                                                 
-----------     ----                                  -------    ------                                                                                                                                 
Cmdlet          Add-HXProtectedVMToGroup              5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Connect-HXCluster                     5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Disconnect-HXCluster                  5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXCluster                         5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXTaskStatus                      5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXProtectedVM                     5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXProtectionGroup                 5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXFailover                     5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareFailover              5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareGroupRecovery         5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareReverseProtect        5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXReverseProtect               5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXTestFailover                 5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          New-HXProtectionGroup                 5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Protect-HXVM                          5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Remove-HXProtectedVMFromGroup         5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Remove-HXProtectionGroup              5.0.0.3    Cisco.Runbook                                                                                                                          
Cmdlet          Unprotect-HXVM                        5.0.0.3    Cisco.Runbook     
Sample Output:
CommandType     Name                                  Version    Source                                                                                                                                 
-----------     ----                                  -------    ------                                                                                                                                 
Cmdlet          Add-HXProtectedVMToGroup              1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Connect-HXCluster                     1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Disconnect-HXCluster                  1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXCluster                         1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXJobStatus                       1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXProtectedVM                     1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Get-HXProtectionGroup                 1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXFailover                     1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareFailover              1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareGroupRecovery         1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXPrepareReverseProtect        1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXReverseProtect               1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Invoke-HXTestFailover                 1.0        Cisco.Runbook                                                                                                                          
Cmdlet          New-HXProtectionGroup                 1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Protect-HXVM                          1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Remove-HXProtectedVMFromGroup         1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Remove-HXProtectionGroup              1.0        Cisco.Runbook                                                                                                                          
Cmdlet          Unprotect-HXVM                        1.0        Cisco.Runbook     

Getting Help

To get help for the Cisco HXPowerCLI commands, you can use the Get-help cmdlet.

For example:

Get-help Connect-HXCluster
Output:
NAME
    Connect-HXCluster
SYNOPSIS
    Connects to the HX Cluster.
SYNTAX
    Connect-Cluster [-ClusterIP] <string> [[-Credential] <PSCredential>] [[-Username] <string>] [[-Password] <string>] [<CommonParameters>]
DESCRIPTION
    Connects to the HX Cluster.
RELATED LINKS
    Disconnect-HXCluster 
    Get-HXCluster 
REMARKS
    To see the examples, type: "get-help Connect-HXCluster -examples".
    For more information, type: "get-help Connect-HXCluster -detailed".
    For technical information, type: "get-help Connect-HXCluster -full".
    For online help, type: "get-help Connect-HXCluster -online". 

To display the full help content for a Cisco HXPowerCLI command, you can use the get-help <command> -full cmdlet:

For example:

get-help Connect-HXCluster -full
NAME
    Connect-HXCluster
   SYNOPSIS
    Connects to the HX Cluster.
     SYNTAX
    Connect-Cluster [-ClusterIP] <string> [[-Credential] <PSCredential>] [[-Username] <string>] [[-Password] <string>] [<CommonParameters>]
    DESCRIPTION
    Connects to the HX Cluster.
   PARAMETERS
    -Credential <PSCredential>
        Specify the user's credential for the cluster.
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
     -cred <PSCredential>
        Specify the user's credential for the cluster.
        This is an alias of the Credential parameter.
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
      -ClusterIP <string>
        Specify the HX Cluster IP.
        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      -Cluster <string>
        Specify the HX Cluster IP.
        This is an alias of the ClusterIP parameter.
        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      -Username <string>
        Specify the username for the HX Cluster.
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      -user <string>
        Specify the username for the HX Cluster.
        This is an alias of the Username parameter.
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      -Password <string>
        Specify the password for the HX Cluster.
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      -pwd <string>
        Specify the password for the HX Cluster.
        This is an alias of the Password parameter.
        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
      <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 
    INPUTS
    System.Management.Automation.PSCredential
        Specify the user's credential for the cluster.
    OUTPUTS
    IO.Swagger.Model.VirtualMachine
    ----------  EXAMPLE 1  ----------
    C:\> Connect-HXCluster -ClusterIP 10.198.14.227 -Username root -Password abc
    Output
    -----------------------------
    10.198.14.227 is connected..
    RELATED LINKS
    Disconnect-HXCluster 
    Get-HXCluster 

Viewing Examples

To view examples for the Cisco HXPowerCLI commands, you can use the get-help Connect-HXCluster -examples cmdlet.

For example:

PS C:\> get-help Connect-HXCluster -examples
NAME
    Connect-HXCluster
 SYNOPSIS
    Connects to the HX Cluster.
   ----------  EXAMPLE 1  ----------
    C:\> Connect-HXCluster -ClusterIP 10.198.14.227 -Username root -Password abc
    Output
   -----------------------------
    10.198.14.227 is connected.