v4.0.2

• Fixed url encoding for boolean values in Get-IBObject filters passed by hashtable

v4.0.1

• Fixed error handling on public functions that were either throwing double errors in some cases or mis-attributing the function where the error occurred.

v4.0.0

New Features

• Get/New/Set/Remove-IBObject all now have a -BatchMode switch and -BatchGroupSize integer parameter. Using these can increase performance when used with pipeline input by grouping the objects into fewer WAPI calls using the WAPI request object instead of making a separate call for each input.
  • WAPI seems to treat these batch requests as a single transaction. So if one of the requests in a group fails, the rest are cancelled/reverted.
  • The default batch group size is 1000 which corresponds to the maximum page size when doing Get queries. But there is no Infoblox documented maximum, so the size can theoretically be increased to the Int32 maximum of 2147483647.
• The module now supports running stateless by using an environment variable based connection profile. (Guide)
• Connection profiles can now be stored using PowerShell SecretManagement instead of a local config file. (Guide)
• Documentation Revamp
  • https://docs.dvolve.net/Posh-IBWAPI/ is a new dedicated website for Posh-IBWAPI documentation. Existing guides and tutorials have been migrated there from the Github wiki. The site is currently generated using the Markdown files in the docs folder in the main project repository by MkDocs. So it should now be easier to contribute fixes and updates.
  • The native module help is now also generated by platyPS from the Markdown files in docs/Functions.
  • Get-Help <function name> -Online should now open your browser to the appropriate page on the documentation site.

Enhancements

• The -Filter parameter on Get-IBObject now supports using an IDictionary (such as a hashtable) to specify filters rather than just a string array.
  • For example, -Filter @{'name~'='myrec'} is the same as -Filter 'name~=myrec'.
  • Filters passed by dictionary will be automatically URL encoded instead of the caller needing to URL encode the filters in advance. This most useful when using regular expressions with a lot of special characters.
  • String based filters will continue to be passed as-is in the HTTP GET request like they were prior to 4.0.
• The module will keep a cache of "readable fields" when Get-IBObject is used with -ReturnAll so that subsequent calls for all fields from the same object type won't need to make additional schema queries.
• Invoke-IBWAPI will now automatically handle UTF-8 encoding JSON bodies when -ContentType is not specified. When -ContentType is specified, the body parameter will be sent as-is.
• Invoke-IBWAPI has an additional parameter set which takes a -WAPIHost, -WAPIVersion, and -Query parameter instead of the normal -Uri parameter.
• Tweaked Verbose and Debug logging throughout the module. JSON request bodies are now included in the Verbose output for functions that send them.

Breaking Changes

• Most errors returned by the WAPI have been changed from terminating to non-terminating errors to better adhere to PowerShell standards. This will have a few notable effects on scripts using this module:
  • If there is an error thrown from one of the input objects when using the pipeline, the error will be sent to the error stream and the pipeline will continue processing the next object instead of terminating.
  • When you call a module function from within a script and it generates an error, the error will be sent to the error stream and the rest of the script will still be executed instead of terminating.
  • If your scripts currently depend on functions throwing terminating errors, you can re-enable that behavior by passing the -ErrorAction Stop parameter or setting the $ErrorActionPreference = 'Stop' variable which is normally set to Continue.
• The minimum PowerShell version requirements have been increased to 5.1 for legacy Windows PowerShell and 7.0 for cross-platform PowerShell. Partial functionality may still work on older versions, but they are no longer being tested against.
• The -Filters parameter on Get-IBObject has been renamed to -Filter but will continue to have a -Filters alias until at least the next major version.
• The -ReturnAllFields parameter on Get-IBObject has been renamed to -ReturnAll but will continue to have a -ReturnAllFields alias until at least the next major version.
• The -ReturnBaseFields paraemter on Get/Set/New-IBObject has been renamed to -ReturnBase but will continue to have a -ReturnBaseFields alias until at least the next major version.
• The -ReturnFields parameter on Get/Set/New-IBObject has been renamed to -ReturnField but will continue to have a -ReturnFields alias until at least the next major version.
• Automatic migration from 1.x connection profiles is no longer supported.

v3.2.2

• Added ObjectType argument completer for Get-IBObject, New-IBObject, and Get-IBSchema. Currently requires having already run Get-IBSchema to cache the potential values.
• Fixed issue propagating SkipCertificateCheck switch in api calls during Send-IBFile and Receive-IBFile

v3.2.1

• Added additional examples on New-IBObject and Get-IBObject (Thanks @qlikq)
• Fixed Send-IBFile throwing a PropertyNotFound exception when no FunctionArgs are specified. (#55) (Thanks @demdante)
• Fixed Remove-IBConfig -All not working
• Corrupt or unparseable config files are now handled more gracefully.
• Added a warning when importing a config on Linux/Mac that was originally created on Windows
• Export-IBConfig no longer writes an output file if no profiles are defined.

v3.2.0

• An optional ProfileName parameter has been added to the public functions that already accept connection specific parameters (#49). This will allow you to switch profiles on a per-call basis more easily. The connection specific parameters will still override the a specified profile's values. These are the affected functions:
  • Get-IBObject
  • Get-IBSchema
  • Invoke-IBFunction
  • New-IBObject
  • Receive-IBFile
  • Remove-IBObject
  • Send-IBFile
  • Set-IBObject
• ProfileName is now a positional parameter in Remove-IBConfig
• Minor efficiency improvements in Get-IBObject for results with many pages.
• The name of the default branch in git has been renamed from master to main.

v3.1.2

• Fixed bug with Remove-IBObject that would inherit invalid return field parameters in some cases.

v3.1.1

• Better error handling in Set-IBConfig when ProfileName not specified and no active profile selected. (#47)
• Fixed dev install script for redirected docs locations

v3.1.0

• Added OverrideTransferHost switch to Send-IBFile and Receive-IBFile which tweaks the WAPI supplied transfer URL so that the hostname matches the WAPIHost value originally passed to the function. It also copies the state of the SkipCertificate switch to the transfer call.
• Send-IBFile will no longer lock the file being uploaded so other readers can't read it.
• Fixed file encoding in Send-IBFile when uploading non-ascii files.
• Fixed Receive-IBFile on PowerShell Core by working around an upstream bug (#43)
• Fixed Get-IBObject's ReturnAllFields parameter when not querying the latest WAPI version

v3.0.0

• Breaking Changes
  • The change to ObjectType parameter in Invoke-IBFunction has been reverted to ObjectRef like in 1.x. I totally confused myself during 2.x development of the *-IBFile functions and thought it had been wrong the whole time. It seems silly to do another major version change after two days. But breaking changes demand it according to semver.
  • The ObjectType parameter in Send-IBFile and Receive-IBFile have been changed to ObjectRef to match Invoke-IBFunction. Both still default to 'fileop' and have parameter aliases for 'type' and 'ObjectType' to maintain compatibility with the short lived 2.x codebase.
• Fixed example in Invoke-IBFunction help.