readme.txt
|
============================
R E A D M E N O T E S ============================ QConvergeConsole FastLinQ PowerKit for Windows, Linux and ESXi Copyright (c) 2018 Cavium, Inc. All rights reserved. Table of Contents ----------------- 1. Introduction 2. Prerequisites 3. Scope 4. Limitation 5. Installation 6. UnInstallation 7. Executing/Running Cmdlets 8. Known Issues 1. Introduction: ================ QConvergeConsole FastLinQ PowerKit is a PowerShell kit for managing QLogic 34xx/84xx/45xxx family of adapters using PowerShell Cmdlets. The QConvergeConsole FastLinQ PowerKit consists of the following three components. a] WMIv2, OMI provider and qlgcfastlinq ESXi Provider for Windows, Linux and ESXi respectively. b] PowerShell Cmdlets for managing QLogic FastLinQ 34xx/84xx/45xxx adapter family. c] RestAPI interface for managing QLogic FastLinQ 34xx/84xx/45xxx adapter family. 2. Prerequisites: ================ a] WMIv2/OMI/qlgcfastlinq ESXi provider or QLNX-Agent for Windows/Linux/ESXi is installed properly on the host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family that is to be managed by the FastLinQ Cmdlets. b] QConvergeConsole FastLinQ PowerKit be installed properly on the Windows system from which you plan to manage the local/remote Windows, Linux and ESXi host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family. c] Appropriate device driver for the QLogic NIC is to be installed on the host system that is to be managed by the QConvergeConsole FastLinQ PowerKit. d] OmiServer must be installed prior to installing the OMI provider on host Linux systems. e] For managing iscsi on Linux hosts, open-iscsi and sg utilities are required to be installed on the Linux host. f] Microsoft iSCSI initiator be installed on the Windows host server. g] On the Windows machine where the PowerKit is getting installed, the QLNX-Agent version MUST be versioned 4.111.1000.79 or higher. 3. Scope: ========= a] Windows: Supported Operating Systems for the WMIv2 provider or the QConvergeConsole FastLinQ PowerKit as folllows. # Windows Server 2012 # Windows Server 2012 R2 # Windows Server 2016 (includes Nano Server) b] Linux: Supported Operating Systems for the OMI provider and OMI server/CIMOM as folllows. # All Linux distros that OMI server/CIMOM is supported. # Please refer to the following link for further details on OMI server/CIMOM: https://collaboration.opengroup.org/omi/ c] VMware-ESXi: Supported Operating Systems for qlgcfastlinq VMware ESXi provider and SFCB server/CIMOM as follows. # ESXi_5.5 # ESXi_6.0 # ESXi_6.5 # ESXi_6.7 4. Limitation: ============== 1. Firewall exceptions need to be made for remote host system management using Cmdlets. 5. Installation: ================ 1. Windows: ----------- a] Copy the QConvergeConsole FastLinQ PowerKit files to the Windows host. b] Open a powerShell prompt as an administrator and navigate to the directory where you copied the installer files. c] Run the following command to install both WMIv2 provider and the cmdlets: # Import-Module .\InstallFastLinqPowerKit.ps1 -Force (or) Simply run below command on "power-shell prompt new session". # .\InstallFastLinqPowerKit.ps1 - A message will pop-up asking if you want if you want to run software from an untrusted publisher. Type/click 'A' for 'Always run'. d] The cmdlets will be immediately available. - Start typing "Get-QLGC" and press tab. - Continue typing Get-QLGC and then press tab. - The Get-QLGCAdapter cmdlet should auto-populate. Run the command to confirm the cmdlets are working properly. Note: 1] Please make sure that uninstall the old provider and Cmdlets if you installed earlier, before installation of new provider and Cmdlets. 2. Linux: --------- a] Download and install the latest OMI server/CIMOM from: https://collaboration.opengroup.org/omi/ b] Make sure omiserver is running on the Linux host system and use the below commands to set port. # /opt/omi/bin/omiserver --> To see the status of OMI Server. # /opt/omi/bin/omiserver -s --> To stop OMI Server on Linux host system. # /opt/omi/bin/omiserver --httpport 5985 --httpsport 5986 -d --> To start OMI Server and set the http port. c] Copy the appropriate QLogic OMI provider rpm package: QLGC_OMIProvider-X.X.XX-0.i386.rpm (For x86 Linux) QLGC_OMIProvider-X.X.XX-0.x86_64.rpm (For x64 Linux) d] Install the appropriate QLogic OMI provider rpm package. Example: # rpm -ivh QLGC_OMIProvider-X.X.XX-0.x86_64.rpm e] Restart the omiserver if necessary. f] Add firewall exceptions to open up the omiserver ports for remote cmdlets to talk to the OMI server/provider. Note: 1] Please make sure that uninstall the old provider if you installed earliar, before installation of new provider. 3. ESXi: -------- Follow the below commands to install QLogic qlgcfastlinq VMware ESXi provider VIB on ESXi Host System. # esxcli software vib install -f -d vmware-esx-provider-qlgcfastlinq.zip Note: 1] Please make sure that uninstall the old OMI-Provider if you installed earliar, before installation of new OMI-Provider. 2] The user must reboot the server after successfull installation/uninstallation of provider. 6. UnInstallation: ================== 1. Windows: ----------- Follow the below commands to uninstall the QConvergeConsole FastLinQ PowerKit: a] Open a powershell prompt as administrator and navigate to the directory containing the installer files. b] Run the following command to uninstall the cmdlets: Import-Module .\UninstallFastLinqPowerKit.ps1 -Force (or) simply run as below on new powershell prompt session. .\UninstallFastLinqPowerKit.ps1 c] Confirm uninstallation by attempting to run Get-QLGCAdapter and having it fail. Cmdlets that you have already used in the current PowerShell session may still auto-populate, but will not work if they are ran. 2. Linux: --------- Use below commands to uninstall the QLogic OMI provider rpm package which was installed earliar: # rpm -qa | grep -i QLGC_OMIProvider --> Just to check if the OMI Provider installed or not. # rpm -e QLGC_OMIProvider --> To uninstall OMI Provider. 3. ESXi: -------- Follow the below commands to uninstall QLogic qlgcfastlinq VMware ESXi provider VIB on ESXi Host System. # esxcli software vib list | grep -i qlgcfastlinq --> Just to check if the qlgcfastlinq ESXi Provider installed or not on Server. # esxcli software vib remove -n qlgcfastlinq --> To uninstall qlgcfastlinq ESXi Provider. Note: 1] The user must reboot the server after successfull installation/uninstallation of provider. 7.Executing/Running Cmdlets: ============================ Notes: ====== a] Windows or Linux or ESXi host systems with QLogic FastLinQ 34xx/84xx/45xxx adapter family can be managed by QConvergeConsole FastLinQ PowerKit Cmdlets. b] You need to have the QConvergeConsole FastLinQ PowerKit installed on a Windows system from which you plan to manage locally or remotely the Windows/Linux/ESXi host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family. c] For managing Windows host systems with QLogic FastLinQ 34xx/84xx/45xxx adapter family, you need to either have the QConvergeConsole FastLinQ PowerKit installed with WMIv2 provider or alternatively have QLNX-Agent installed. d] For managing Linux host systems with QLogic FastLinQ 34xx/84xx/45xxx adapter family, you need to either have the OMI server/CIMOM installed along with the OMI provider or alternatively have QLNX-Agent installed. e] Use the "Connect-QLGCHost" cmdlet for connecting to remote Linux/Windows host system (that has QLogic FastLinQ 34xx/84xx/45xxx adapter family) which has QLNX-Agent installed. Do "Get-Help Connect-QLGCHost" to get more help on how to use the "Connect-QLGCHost" cmdlet. Note: "Connect-QLGCHost" cmdlet doest not support ESXi OS. The user can execute Cmdlets on Local and Remote Host systems as following. a] [Local Windows Host System] b] [Local Windows Host System] --> [Remote Windows Host System] c] [Local Windows Host System] --> [Remote Linux Host System] d] [Local Windows Host System] --> [Remote ESXi Host System] a] [Local Windows Host System]: ----------------------------- - Use the following procedure to connect to a local Windows host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family which has the WMIv2 provider already installed: step 1 - Install the latest QConvergeConsole FastLinQ PowerKit on Local Windows Host System. Step 2 - Run desired Cmdlets on Local Windows Host System. # Get-QLGCAdapter # Get-QLGCFunction - Just invoke the desired QConvergeConsole FastLinQ PowerKit cmdlet to managed QLogic FastLinQ 34xx/84xx/45xxx adapters on the local Windows host system. Note: You can get the usage/Help of Cmdlet as follows. # Get-Help <Cmdlet_Name> [-Examples | -Detailed | -Full ] Example: # Get-Help Get-QLGCAdapter # Get-Help Get-QLGCAdapter -Examples # Get-Help Get-QLGCAdapter -Full # Get-Help Get-QLGCAdapter -Detailed b] [Local Windows Host System] --> [Remote Windows Host System]: ---------------------------------------------------------------- - Use the following procedure to connect to a remote Windows host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family which has the WMIv2 provider already installed or alternatively have QLNX-Agent installed. Step 1 - Install the latest QConvergeConsole FastLinQ PowerKit on Local Windows Host System. Step 2 - Add the Remote Windows Host System to trusted host on Local Windows Host System. Example: # winrm set winrm/config/client @{TrustedHosts="172.2835.225"} --> Run on local Windows machine [in cmd prompt run as admin] Step 3 - Install the latest QLNX-Agent or QConvergeConsole FastLinQ PowerKit on Remote Windows Host System. Step 4 - Create the cim session on Local Windows Host System.. Syntax: # $Cred = Get-Credential <UserName with sudo privileges> # $Session = New-CimSession -ComputerName <Host IP address> -Authentication Negotiate -Credential $Cred -OperationTimeoutSec 1200000 # Get-CimSession Example: # $Cred = Get-Credential Administrator # $Session = New-CimSession -ComputerName 172.28.35.225 -Authentication Negotiate -Credential $Cred -OperationTimeoutSec 1200000 # Get-CimSession Step 5 - Run desired Cmdlet using CimSession on Local Windows Host System. - Invoke the desired cmdlet with "-CimSession $Session" option # Get-QLGCAdapter -CimSession $Session c] [Local Windows Host System] --> [Remote Linux Host System]: -------------------------------------------------------------- - Use the following procedure to connect to a remote Linux host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family which has both OMI server/CIMOM and OMI provider installed: Step 1 - Install OMI server on Remote Linux Host System if not installed earlier. Step 2 - Install latest OMI Provider on Remote Linux Host System. Step 3 - If you are installing the OMI server 1st time follow the below steps. # /opt/omi/bin/omiserver -s --> To stop OMI Server on remote linux host machine. # /opt/omi/bin/omiserver --httpport 5985 --httpsport 5986 -d --> To start OMI Server and set the http port. # /opt/omi/bin/omiserver --> To stop OMI Server on remote linux machine. Note: Add firewall exceptions to open up the omiserver ports for remote cmdlets to talk to the OMI server/OMI provider. Step 4 - Install the latest QConvergeConsole FastLinQ PowerKit on Local Windows Host System. Step 5 - Add the Remote Linux Host System to trusted host on Local Windows Host System. Example: # winrm set winrm/config/client @{TrustedHosts="172.28.35.285"} --> Run on local Windows machine [in cmd prompt run as admin] Step 6 - Create the cim session Local Windows Host System. Syntax: # $Cred = Get-Credential <UserName with sudo privileges> # $Session = New-CimSession -ComputerName <Host IP address> -Authentication Basic -Credential $Cred -OperationTimeoutSec 1200000 # Get-CimSession Example: # $Cred = Get-Credential root # $Session = New-CimSession -ComputerName 172.28.35.285 -Authentication Basic -Credential $Cred -OperationTimeoutSec 1200000 # Get-CimSession Step 7 - Run desired Cmdlet using CimSession on Local Windows Host System.. - Invoke the desired cmdlet with "-CimSession $Session" option. Examples: # Get-QLGCAdapter -CimSession $Session d] [Local Windows Host System] --> [Remote ESXi Host System]: ------------------------------------------------------------- - Use the following procedure to connect to a remote ESXi host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family which has both SFCB server/CIMOM and qlgcfastlinq vmware ESXi provider installed: Step 1 - Install latest qlgcfastlinq VMware-ESXi Provider VIB on Remote ESXi Host System. Step 2 - Reboot the server after installation of Provider VIB. Other Commands: # /etc/init.d/sfcbd-watchdog restart --> To restart SFCB server on remote ESXi machine. # /etc/init.d/sfcbd-watchdog stop --> To stop SFCB server on remote ESXi host machine. # /etc/init.d/sfcbd-watchdog start --> To start SFCB server. Note: Add firewall exceptions to open up the SFCB ports for remote cmdlets to talk to the SFCB server/provider. Step 3 - Install the latest QConvergeConsole FastLinQ PowerKit on Local Windows Host System. Step 4 - Add the Remote ESXi Host System to trusted host on Local Windows Host System. Example: winrm set winrm/config/client @{TrustedHosts="172.28.35.285"} --> Run on local Windows machine [in cmd propmt run as admin] Step 5 - Create the cim session as folllows on Local Windows Host System. # $Cred = Get-Credential <UserName with sudo privileges> # $CIMOpt = New-CimSessionOption -SkipCACheck -SkipCNCheck -SkipRevocationCheck -Usessl # $Session = New-CimSession -ComputerName <Host IP address> -Authentication Basic -Credential $Cred $CIMOpt -port 443 -OperationTimeoutSec 1200000 # Get-CimSession Example: # $Cred = Get-Credential root # $CIMOpt = New-CimSessionOption -SkipCACheck -SkipCNCheck -SkipRevocationCheck -Usessl # $Session = New-CimSession -Authentication Basic -Credential $Cred -ComputerName "172.28.3.190" -Sessionoption $CIMOpt -port 443 -OperationTimeoutSec 1200000 Step 6 - Run desired Cmdlet using CimSession on Local Windows Host System.. Examples: # Get-QLGCAdapter -CimSession $Session - Invoke the desired cmdlet with "-CimSession $Session" option. 8. Known Issues: ================ 1. Do not have the ability to create iFace files using cmdlets. Workaround is to use QCC or QCScli to create iFace files. 2. Unable to add iSNS server to Windows 2016 Nano server. 3. Unable to login to targets with iSCSI CHAP on Linux. 4. Diagnostics fails on Windows 2016 Nano server. 5. On the Windows machine where the PowerKit is getting installed, the QLNX-Agent version MUST be versioned 4.111.1000.79 or higher. Otherwise, Powerkit installation would fail with the following error: Error: REST API test failed StatusCode: 500 StatusDescription: Internal Server Error. Subsequently cmdlets execution would also fail. So, please update to a QLNX-Agent version 4.111.1000.79 or higher. 6. The Following Set-Operation (modify Instance) do not supported on ESXi Host system. 1] Set-QLGCResCfg 2] Set-QLGCPhyPortLLDPConfig |