readme.txt
|
============================
R E A D M E N O T E S ============================ QConvergeConsole FastLinQ PowerKit for Windows and Linux Copyright (c) 2016 QLogic Corporation All rights reserved. Table of Contents ----------------- 1. Introduction 2. Requirements 3. Scope 4. Limitation 5. Additional Notes 6. Installation 7. UnInstallation 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. * WMIv2/OMI provider for Windows/Linux respectively. * PowerShell Cmdlets for managing QLogic FastLinQ 34xx/84xx/45xxx adapter family * RestAPI interface for managing QLogic FastLinQ 34xx/84xx/45xxx adapter family 2. Requirements: ================ 1. WMIv2/OMI/QLNX-Agent provider for Windows/Linux is installed properly on the host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family that is to be managed by the FastLinQ Cmdlets. 2. QConvergeConsole FastLinQ PowerKit be installed properly on the Windows system from which you plan to manage the local/remote Windows/Linux host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family. 3. Appropriate device driver for the QLogic NIC is installed on the host system that is to be managed by the QConvergeConsole FastLinQ PowerKit. 4. OmiServer be installed prior to installing the OMI provider on host Linux systems. 5. For managing iscsi on Linux hosts, open-iscsi and sg utilities are required to be installed on the Linux host. 6. Microsoft iSCSI initiator be installed on the Windows host server. 7. 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: ========= Supported Operating Systems for the WMIv2 provider or the QConvergeConsole FastLinQ PowerKit: - Windows Server 2012 - Windows Server 2012 R2 - Windows Server 2016 (includes Nano Server) Supported Operating Systems for the OMI provider: - 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/ 4. Limitation: ============== 1. Firewall exceptions need to be made for remote host system management using Cmdlets. 5. Additional Notes: ==================== 1. Windows or Linux host systems with QLogic FastLinQ 34xx/84xx/45xxx adapter family can be managed by QConvergeConsole FastLinQ PowerKit Cmdlets. 2. 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. 3. 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. 4. 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 host system with QLogic FastLinQ 34xx/84xx/45xxx adapter family. 5. Just invoke the desired QConvergeConsole FastLinQ PowerKit cmdlet to managed QLogic FastLinQ 34xx/84xx/45xxx adapters on the local Windows host system. 5. 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. 6. 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: $Cred = Get-Credential <UserName with Administrator privileges> $Session = New-CimSession -ComputerName <Host IP address> -Authentication Negotiate -Credential $Cred Invoke the desired cmdlet with "-CimSession $Session" option. For e.g: Get-QLGCAdapter -CimSession $Session 7. 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: $Cred = Get-Credential <UserName with sudo privileges> $Session = New-CimSession -ComputerName <Host IP address> -Authentication Basic -Credential $Cred Invoke the desired cmdlet with "-CimSession $Session" option. For e.g: Get-QLGCAdapter -CimSession $Session 6. Installation: ================ 1. Windows: a) Copy the QConvergeConsole FastLinQ PowerKit files to the Windows host. b) Open a powershell prompt as administrator and navigate to the directory you copied the installer files to c) Run the following commands to install both WMIv2 provider and the cmdlets: Import-Module QLogicFastLinQPowerKit -Force Install-QLogicFastLinqPowerKit -ExecutionPolicy AllSigned -AddAccountToIIS:$true -Credential Administrator -WinRMConfiguration:$true -SetupRESTAPI:$true d) The cmdlets will be immediately available. Start typing "Get-QLGC" and press tab. A message will popup asking if you want if you want to run software from an untrusted publisher. Type/click 'A' for 'Always run'. e) 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. 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. c) Copy the appropriate QLogic OMI provider rpm package: QLGC_OMIProvider-1.0.19-0.i386.rpm (For x86 Linux) QLGC_OMIProvider-1.0.19-0.x86_64.rpm (For x64 Linux) d) Install the appropriate QLogic OMI provider rpm package. 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. 7. UnInstallation: ================== To uninstall the QConvergeConsole FastLinQ PowerKit: 1. Open a powershell prompt as administrator and navigate to the directory containing the installer files. 2. Run the following command to uninstall the cmdlets: Uninstall-QLogicFastLinqPowerKit 3. 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. 8. Known Issues: ================ 1. iSCSI boot config operations are not fully supported. Workaround is to use QCC or QCScli to configure iSCSI boot. 2. Do not have the ability to create iFace files using cmdlets. Workaround is to use QCC or QCScli to create iFace files. 3. Unable to add iSNS server to Windows 2016 Nano server. 4. Unable to login to targets with iSCSI CHAP on Linux. 5. Diagnostics fails on Windows 2016 Nano server. 6. 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. |