Connect-OVMgmt : [Send-OVRequest]: The specified API version is not valid. Check the value of the X-API-Version header, then resend the request.

[curiousbytes]

hello team,

The aforementioned error normally relegates to module and OV API mismatch, however, this is not the case here.
In specific, the module I'm using is HPEOneView.660 and I'm trying to connect to a 5.30 appliance.
According to 6.60 Supported HPE OneView REST API it should support from 5.20 towards.

Some info from the environment I'm using:

PS C:\> gcm Connect-OVMgmt | ft -AutoSize

CommandType Name           Version        Source
----------- ----           -------        ------
Function    Connect-OVMgmt 6.60.3227.2799 HPEOneView.660

C:\> gmo -Name *hpe* -ListAvailable|ft -AutoSize

    Directory: C:\Users\mantonak\Documents\WindowsPowerShell\Modules

ModuleType Version        Name           ExportedCommands
---------- -------        ----           ----------------
Binary     3.2.0.0        HPEiLOCmdlets  {Add-HPEiLODirectoryGroup, Add-HPEiLOFederationGroup, Add-HPEiLOInstallationQueueWaitTask, Add-HPEiLOInstallSet...}
Binary     2.0.0.0        HPEOACmdlets   {Add-HPEOARouteIPv6, Remove-HPEOARouteIPv6, Clear-HPEOAFirmwareLog, Get-HPEOAAlertmail...}
Script     6.60.3227.2799 HPEOneView.660 {Get-OVSanManager, Set-OVRemoteSyslog, Add-OVBaseline, Remove-OVLdapGroup...}

PS C:\> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.14393.5127
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.14393.5127
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

PS C:\> Get-Item 'HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\' |  Get-ItemPropertyValue -Name Release
528049

The error I'm getting:

PSMessageDetails      :
Exception             : System.Net.WebException: The remote server returned an error: (412) Precondition Failed.
                           at System.Net.HttpWebRequest.GetResponse()
                           at CallSite.Target(Closure , CallSite , WebRequest )
TargetObject          :
CategoryInfo          : NotSpecified: (:) [], WebException
FullyQualifiedErrorId : WebException
ErrorDetails          :
InvocationInfo        : System.Management.Automation.InvocationInfo
ScriptStackTrace      : at Send-OVRequest<Process>,[REDACTED]\Documents\WindowsPowerShell\Modules\HPEOneView.660\6.60.3227.2799\HPEOneView.660.psm1: line 6247
                        at Connect-OVMgmt<Begin>, [REDACTED]\Documents\WindowsPowerShell\Modules\HPEOneView.660\6.60.3227.2799\HPEOneView.660.psm1: line 8186
                        at <ScriptBlock>, <No file>: line 1
PipelineIterationInfo : {}

VERBOSE: [SEND-OVREQUEST] Exception Message: The remote server returned an error: (412) Precondition Failed.
VERBOSE: [SEND-OVREQUEST] InnerException FullyQualifiedErrorId:
VERBOSE: [SEND-OVREQUEST] InnerException Message:
VERBOSE: [SEND-OVREQUEST] Exception
VERBOSE: [SEND-OVREQUEST] Getting Error Response
**VERBOSE: [SEND-OVREQUEST] ERROR RESPONSE: {"errorSource":null,"data":{},"details":"The request contained an invalid X-API-Version header of 3200.  Only values 1 through
1800 are accepted.","message":"The specified API version is not
valid.","messageParameters":[],"nestedErrors":[],"errorCode":"INVALID_API_VERSION","recommendedActions":["Check the value of the X-API-Version header, then resend the
request."]}**
VERBOSE: [SEND-OVREQUEST] Response Status: HTTP 412 [Precondition Failed]
VERBOSE: [SEND-OVREQUEST] Response Header: Pragma = no-cache
VERBOSE: [SEND-OVREQUEST] Response Header: Vary = application/json; charset=UTF-8
VERBOSE: [SEND-OVREQUEST] Response Header: Content-Language = Fri, 07 Oct 2022 12:38:37 GMT
VERBOSE: [SEND-OVREQUEST] Response Header: X-Frame-Options = 0
VERBOSE: [SEND-OVREQUEST] Response Header: Keep-Alive = Apache
VERBOSE: [SEND-OVREQUEST] Response Header: Connection =
VERBOSE: [SEND-OVREQUEST] Response Header: Transfer-Encoding =
VERBOSE: [SEND-OVREQUEST] Response Header: Cache-Control =
VERBOSE: [SEND-OVREQUEST] Response Header: Content-Type =
VERBOSE: [SEND-OVREQUEST] Response Header: Date =
VERBOSE: [SEND-OVREQUEST] Response Header: Expires =
VERBOSE: [SEND-OVREQUEST] Response Header: Server =
VERBOSE: [NEW-ERRORRECORD] Building ErrorRecord object
VERBOSE: [SEND-OVREQUEST] Cleaning up HttpWebRequest
VERBOSE: [CONNECT-OVMGMT] Exception caught when checking X-API version.
Connect-OVMgmt : [Send-OVRequest]: The specified API version is not valid. Check the value of the X-API-Version header, then resend the request.
At line:1 char:1
+ Connect-OVMgmt -Hostname [REDACTED] -UserName [REDACTED] -Ve ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (Send-OVRequest:String) [Connect-OVMgmt], InvalidOperationException
    + FullyQualifiedErrorId : INVALID_API_VERSION,Connect-OVMgmt

Strangely I'm getting the same error on a 6.20 appliance.
I can connect to plenty other appliances (5.60, 6.00, 6.30, 6.60 etc)

[VincentBerger]

The backwards compatibility is the other way around: you can use an older Powershell library to connect to a newer appliance (because that appliance has the older API entry points as mentioned in the doc), you cannot use a newer library to connect to an older appliance (because that appliance knows nothing about the newer API endpoint the library is asking for)

[curiousbytes]

@VincentBerger I understand your point even though I believe we should be able to go both backwards & forward compatible. In any case this is another discussion. Is there a best practice in order to cope in environments with multiple OV versions? Keeping multiple module versions and removing/importing them per scenario is the only way?

[VincentBerger]

Several different approaches are possible:

1. Keep multiple module versions and load/unload as required is one, as you mentioned
2. Use the library that matches the oldest appliance in your environment. This assumes you do not need the newer features and/or bug fixes that might be in newer versions of the library
3. My favorite best practice: align OneView versions across the environment. I know this is not always easy...

[curiousbytes]

Thanks @VincentBerger

[ChrisLynchHPE]

It is impossible to ensure that a newer library version can connect to an older version of appliance, as the version of the library will always be that current shipping OneView release. Meaning, the OneView.660 library is locked to the X-API-Version (3800) of HPE OneView 6.60 that does not exist in anything older than that release. HPE OneView 5.30 max API support is 1800. The two are not compatible with each other.