Home made Veeam job Discovery template problem with Powershell and Json

[BenoitAnseaume]

Hello all,

I am trying to make my first template for the community, but I am facing an issue with my zabbix server and JSON discovery.

I want to discover all backup jobs on a Windows Veeam "backup and recovery" server but when my zabbix server receives the JSON data via Zabbix trapper, he always says :
(the data is sent by a PowerShell code and I am using zabbix 6.0.30)



there is the full JSON content :

{
    "data":  [
                 {
                     "{#NOM}":  "dfs1"
                 },
                 {
                     "{#NOM}":  "Wasabi_dfs1"
                 },
                 {
                     "{#NOM}":  "files"
                 },
                 {
                     "{#NOM}":  "Wasabi_files"
                 },
                 {
                     "{#NOM}":  "Wasabi_fw1"
                 },
                 {
                     "{#NOM}":  "Wasabi_dc4"
                 },
                 {
                     "{#NOM}":  "files2"
                 },
                 {
                     "{#NOM}":  "dc4"
                 },
                 {
                     "{#NOM}":  "dc1"
                 },
                 {
                     "{#NOM}":  "Wasabi_laby"
                 },
                 {
                     "{#NOM}":  "fw1"
                 },
                 {
                     "{#NOM}":  "laby"
                 },
                 {
                     "{#NOM}":  "Wasabi_dc1"
                 }
             ]
}​

discovery rule :



item prototype :



If anyone can help me ? I can give other information if needed.

[PeterZielony]

i use this format without data in it as in the documentation here and never had problems

https://www.zabbix.com/documentation/6.0/en/manual/discovery/low_level_discovery/custom_rules

Note that since Zabbix 4.2, the format of the JSON returned by low-level discovery rules has been changed. It is no longer expected that the JSON will contain the "data" object. Low-level discovery will now accept a normal JSON containing an array, in order to support new features such as the item value preprocessing and custom paths to low-level discovery macro values in a JSON document.

Built-in discovery keys have been updated to return an array of LLD rows at the root of JSON document. Zabbix will automatically extract a macro and value if an array field uses the {#MACRO} syntax as a key. Any new native discovery checks will use the new syntax without the "data" elements. When processing a low-level discovery value first the root is located (array at $. or $.data).

While the "data" element has been removed from all native items related to discovery, for backward compatibility Zabbix will still accept the JSON notation with a "data" element, though its use is discouraged. If the JSON contains an object with only one "data" array element, then it will automatically extract the content of the element using JSONPath $.data. Low-level discovery now accepts optional user-defined LLD macros with a custom path specified in JSONPath syntax.

without data it is just easier.

Working with double quotes in powershell can be tricky too especially when using sender as it has to pass string value already double quoted. Also found that removing empty spaces from json when passing to sender helps too.

you can do trickery too. One time i had no time to play with formatting for sender so in powershell i replaced json output char " with ? And then in trapper item brought it back by preprocessing that replaces ? Back to "

[PeterZielony]

json seems wrong for discovery and should opens with square brackets. Your json should look like this:

[
{
"{#NOM}": "dfs1"
},
{
"{#NOM}": "Wasabi_dfs1"
},
{
"{#NOM}": "files"
},
{
"{#NOM}": "Wasabi_files"
},
{
"{#NOM}": "Wasabi_fw1"
},
{
"{#NOM}": "Wasabi_dc4"
},
{
"{#NOM}": "files2"
},
{
"{#NOM}": "dc4"
},
{
"{#NOM}": "dc1"
},
{
"{#NOM}": "Wasabi_laby"
},
{
"{#NOM}": "fw1"
},
{
"{#NOM}": "laby"
},
{
"{#NOM}": "Wasabi_dc1"
}
]

Also you need pre-processing in item prototype

[Markku]

The LLD documentation (https://www.zabbix.com/documentation...evel_discovery) says that the "data" syntax is still accepted.

But, in the screenshot there are no quotes at all, thus the received JSON is invalid. I think you should work with your PowerShell script to ensure that the output data is appropriately quoted.

Markku

[PeterZielony]

i use this format without data in it as in the documentation here and never had problems

https://www.zabbix.com/documentation/6.0/en/manual/discovery/low_level_discovery/custom_rules

Note that since Zabbix 4.2, the format of the JSON returned by low-level discovery rules has been changed. It is no longer expected that the JSON will contain the "data" object. Low-level discovery will now accept a normal JSON containing an array, in order to support new features such as the item value preprocessing and custom paths to low-level discovery macro values in a JSON document.

Built-in discovery keys have been updated to return an array of LLD rows at the root of JSON document. Zabbix will automatically extract a macro and value if an array field uses the {#MACRO} syntax as a key. Any new native discovery checks will use the new syntax without the "data" elements. When processing a low-level discovery value first the root is located (array at $. or $.data).

While the "data" element has been removed from all native items related to discovery, for backward compatibility Zabbix will still accept the JSON notation with a "data" element, though its use is discouraged. If the JSON contains an object with only one "data" array element, then it will automatically extract the content of the element using JSONPath $.data. Low-level discovery now accepts optional user-defined LLD macros with a custom path specified in JSONPath syntax.

without data it is just easier.

Working with double quotes in powershell can be tricky too especially when using sender as it has to pass string value already double quoted. Also found that removing empty spaces from json when passing to sender helps too.

you can do trickery too. One time i had no time to play with formatting for sender so in powershell i replaced json output char " with ? And then in trapper item brought it back by preprocessing that replaces ? Back to "

[Markku]

you can do trickery too. One time i had no time to play with formatting for sender so in powershell i replaced json output char " with ? And then in trapper item brought it back by preprocessing that replaces ? Back to "

Now that's clever! In PowerShell I always have problems with either quoting or character sets

Markku

[BenoitAnseaume]

Bingo ! I have made some adjustments and it work's !

In my PowerShell code, I have replaced the " character into ? as you said, and I replace it back into zabbix preprocessing !

I have also removed the "data" part in the beginning of my JSON.

It works instantly !


There is my PowerShell code :

# Variables
$zabbixServer = "zabbix server"
$zabbixHost = "Zabbix host"
$zabbixSenderPath = "C:\zabbix_agent2\bin\zabbix_sender.exe"

# Veeam module Import
Import-Module Veeam.Backup.PowerShell

# Connection to Veeam Server
Connect-VBRServer -Server "localhost"

# Get Veeam Jobs into a variable
$backupJobs = Get-VBRJob

# Prepare data for Zabbix Discovery
$discoveryData = @()
foreach ($job in $backupJobs) {
    # Clean Zabbix Job Name
    $cleanJobName = $job.Name -replace '[^a-zA-Z0-9_]', ''
    $discoveryData += @{"{#NOM}"=$cleanJobName}
}
#Convert data into Json and replace " with ?
$discoveryJson = $discoveryData | ConvertTo-Json -Compress
$finaljson = $discoveryJson | ForEach-Object {$_ -replace '\"', '?'}
#Send data to Zabbix server
& $zabbixSenderPath -z $zabbixServer -s $zabbixHost -k job.json -o $finaljson

# Prepare job results for Zabbix
foreach ($job in $backupJobs) {
    # Clean Zabbix Job Name
    $cleanJobName = $job.Name -replace '[^a-zA-Z0-9_]', ''
    $jobName = "job[" + $cleanJobName + "]"
    $lastResult = $job.GetLastResult()

    # #Send data to Zabbix server
    & $zabbixSenderPath -z $zabbixServer -s $zabbixHost -k $jobName -o $lastResult
    echo $jobName
}

# Disconnect from zabbix host
Disconnect-VBRServer​

[OndrejBalaz]

Hi, is your template, including the script, functional now? If yes, would you be able to share it publicly, perhaps on GitHub? Thanks.

[BenoitAnseaume]

Yep, There it is : https://github.com/issuyah/Veeam-Zabbix-Simple