icinga-powershell-framework/lib/plugins/Invoke-IcingaCheckCommandBasket.psm1

426 lines
15 KiB
PowerShell
Raw Normal View History

<#
.SYNOPSIS
Exports command as JSON for icinga director
.DESCRIPTION
Invoke-IcingaCheckCommandBasket returns a JSON-file of one or all 'Invoke-IcingaCheck'-Commands, which can be imported via Icinga-Director
When no single command is specified all commands will be exported, and vice versa.
More Information on https://github.com/LordHepipud/icinga-module-windows
.EXAMPLE
PS>Invoke-IcingaCheckCommandBasket
The following commands have been exported:
- 'Invoke-IcingaCheckBiosSerial'
- 'Invoke-IcingaCheckCommandBasket'
- 'Invoke-IcingaCheckCPU'
- 'Invoke-IcingaCheckProcessCount'
- 'Invoke-IcingaCheckService'
- 'Invoke-IcingaCheckUpdates'
- 'Invoke-IcingaCheckUptime'
- 'Invoke-IcingaCheckUsedPartitionSpace'
- 'Invoke-IcingaCheckUsers'
JSON export created to 'C:\Program Files\WindowsPowerShell\Modules\icinga-module-windows\Checks.json'
.EXAMPLE
PS>Invoke-IcingaCheckCommandBasket Invoke-IcingaCheckCPU
The following commands have been exported:
- 'Invoke-IcingaCheckCPU'
JSON export created to 'C:\Program Files\WindowsPowerShell\Modules\icinga-module-windows\Invoke-IcingaCheckCPU.json'
.PARAMETER CheckName
Used to specify a single command which should be exported.
Has to be a single string.
.INPUTS
System.String
.OUTPUTS
System.String
System.Object
.LINK
https://github.com/LordHepipud/icinga-module-windows
.NOTES
#>
function Invoke-IcingaCheckCommandBasket()
{
param(
$CheckName
);
# Check whether all Checks will be exported or just the single one specified
if ($NULL -eq $CheckName) {
$CheckName = (Get-Command Invoke-IcingaCheck*).Name
}
# Variable definition and initialization
2019-09-11 10:07:52 -04:00
[int]$FieldID = 0;
2019-09-13 02:18:31 -04:00
# [int]$FieldNumeration = 0;
2019-09-11 10:07:52 -04:00
[hashtable]$Basket = @{};
# Define basic hashtable structure by adding fields: "Datafield", "DataList", "Command"
2019-09-11 10:07:52 -04:00
$Basket.Add('Datafield', @{});
$Basket.Add('DataList', @{});
$Basket.Add('Command', @{});
# "NoPerfData" gets added to all Checks build and exported no matter what, so we add it from the start
if ($Basket.DataList.ContainsKey('PowerShell NoPerfData') -eq $FALSE) {
2019-09-11 10:07:52 -04:00
# DataList Content for NoPerfData
$Basket.DataList.Add(
'PowerShell NoPerfData', @{
'list_name' = 'PowerShell NoPerfData';
'owner' = $env:username;
'originalId' = '1'; #Gehört noch geändert
'entries' = @(
@{
'entry_name' = '0';
'entry_value:' = "yes";
'format' = 'string';
'allowed_roles' = $NULL;
},
@{
'entry_name' = '1';
'entry_value:' = "no";
'format' = 'string';
'allowed_roles' = $NULL;
}
2019-09-11 10:07:52 -04:00
);
}
);
}
# "Verbose" gets added to all Checks build and exported no matter what, so we add it from the start
if ($Basket.DataList.ContainsKey('PowerShell Verbose') -eq $FALSE) {
$Basket.DataList.Add(
'PowerShell Verbose', @{
'list_name' = 'PowerShell Verbose';
'owner' = $env:username;
2019-09-13 02:18:31 -04:00
'originalId' = '2';
'entries' = @(
@{
2019-09-11 10:07:52 -04:00
'entry_name' = '0';
'entry_value:' = "Show Default";
'format' = 'string';
'allowed_roles' = $NULL;
},
@{
2019-09-11 10:07:52 -04:00
'entry_name' = '1';
'entry_value:' = "Show Operator";
'format' = 'string';
'allowed_roles' = $NULL;
},
@{
2019-09-11 10:07:52 -04:00
'entry_name' = '2';
'entry_value:' = "Show Problems";
'format' = 'string';
'allowed_roles' = $NULL;
},
@{
2019-09-11 10:07:52 -04:00
'entry_name' = '3';
'entry_value:' = "Show All";
'format' = 'string';
'allowed_roles' = $NULL;
}
);
}
);
}
2019-09-11 10:07:52 -04:00
<#
Loop through either:
$CheckName = (Get-Command Invoke-IcingaCheck*).Name
or one of $CheckName = 'Invoke-IcingaCheckCommand'
#>
foreach ($check in $CheckName) {
2019-09-13 02:18:31 -04:00
[int]$FieldNumeration = 0;
if ($check -eq 'Invoke-IcingaCheckCommandBasket') {
} else {
# Get Necessary Syntax-Information and more through cmdlet "Get-Help"
$Data = (Get-Help $check)
# Add Command Structure
2019-09-11 10:07:52 -04:00
$Basket.Command.Add(
$Data.Syntax.syntaxItem.Name, @{
'arguments'= @{
# Gets set for every command as Default
'-C' = @{
'value' = [string]::Format('Use-Icinga; {0}', $Data.Syntax.syntaxItem.Name);
'order' = '0';
}
}
'command' = "C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe";
'disabled' = $FALSE;
'fields' = @{};
'imports' = @();
'is_string' = $NULL;
'methods_excute' = 'PluginCheck';
'object_name' = $Data.Syntax.syntaxItem.Name;
'object_type' = 'object';
'timeout' = '180';
'vars' = @{};
'zone' = $NULL;
}
)
# Loop through Parameter of a given command
foreach ($parameter in $Data.Syntax.syntaxItem.parameter) {
# Filter for Parameter 'core', because its set by default
if ($parameter.name -ne 'core') {
# Is Numeric Check on position to determine the order value
If (Test-Numeric($parameter.position) -eq $TRUE) {
[string]$Order = [int]$parameter.position + 1
} else {
[string]$Order = 99
}
$IcingaCustomVariable = [string]::Format('$PowerShell_{0}_{1}$', $parameter.type.name, $parameter.Name);
#Adding arguments to a given command
if ($parameter.type.name -eq 'switch') {
$Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.Add(
[string]::Format('-{0}', $parameter.Name), @{
'set_if' = $IcingaCustomVariable;
'set_if_format' = 'string';
'order' = $Order;
}
);
$Basket.Command[$Data.Syntax.syntaxItem.Name].vars.Add(
$parameter.Name, "0"
);
# Condotional whether type of parameter is array
} elseif ($parameter.type.name -eq 'array') {
$Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.Add(
[string]::Format('-{0}', $parameter.Name), @{
'value' = [string]::Format('(Split-IcingaCheckCommandArgs {0})', $IcingaCustomVariable);
'order' = $Order;
}
);
} else {
# Default to Object
$Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.Add(
[string]::Format('-{0}', $parameter.Name), @{
'value' = $IcingaCustomVariable;
'order' = $Order;
}
);
if ($parameter.name -ne 'Verbose') {
$Basket.Command[$Data.Syntax.syntaxItem.Name].vars.Add($parameter.Name, '$$null');
} else {
$Basket.Command[$Data.Syntax.syntaxItem.Name].vars.Add($parameter.Name, "0");
}
}
# Fields
# Determine wether a parameter is required based on given syntax-information
if ($parameter.required -eq $TRUE) {
$Required = 'y';
} else {
$Required = 'n';
}
2019-09-11 10:07:52 -04:00
$IcingaCustomVariable = [string]::Format('PowerShell_{0}_{1}', $parameter.type.name, $parameter.Name);
$DataListName = [string]::Format('PowerShell {0}', $parameter.Name)
if ($parameter.type.name -eq 'switch') {
$IcingaDataType='Datalist';
2019-09-11 10:07:52 -04:00
if ($Basket.DataList.ContainsKey($DataListName) -eq $FALSE) {
$Basket.DataList.Add(
$DataListName, @{
'list_name' = $DataListName;
'owner' = $env:username;
'originalId' = '50'; #Gehört noch geändert
'entries' = @{};
}
);
2019-09-11 10:07:52 -04:00
}
} elseif ($parameter.type.name -eq 'Object') {
if ($parameter.Name -eq 'Verbose') {
$IcingaDataType='Datalist'
}
$IcingaDataType='String';
} elseif ($parameter.type.name -eq 'Array') {
$IcingaDataType='Array';
} else {
$IcingaDataType='String';
}
$IcingaDataType = [string]::Format('Icinga\Module\Director\DataType\DataType{0}', $IcingaDataType)
2019-09-11 10:07:52 -04:00
if ($Basket.Datafield.Values.varname -eq $IcingaCustomVariable) {
} else {
$Basket.Datafield.Add(
[string]$FieldID, @{
'varname' = $IcingaCustomVariable;
'caption' = $parameter.Name;
'description' = $NULL;
'datatype' = $IcingaDataType;
'format' = $NULL;
'originalId' = [string]$FieldID;
}
);
if ($parameter.type.name -eq 'switch' -or $parameter.Name -eq 'Verbose') {
$Basket.Datafield[[string]$FieldID].Add(
'settings', @{
'behavior' = 'strict';
'datatype' = 'string';
'datalist' = $DataListName;
}
);
} elseif ($parameter.type.name -eq 'Object') {
$Basket.Datafield[[string]$FieldID].Add(
'settings', @{
'visbility' = 'visible';
}
);
} else {
$Basket.Datafield[[string]$FieldID].Add(
2019-09-13 02:18:31 -04:00
'settings', @{
'visbility' = 'visible';
}
);
}
2019-09-13 02:18:31 -04:00
[int]$FieldID = [int]$FieldID + 1;
}
2019-09-11 10:07:52 -04:00
}
2019-09-13 02:18:31 -04:00
[int]$FieldNumeration = [int]$FieldNumeration + 1;
}
# Check whether or not noperfdata and verbose is set and add it if necessary
if ($Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.ContainsKey('-Verbose') -eq $FALSE) {
$Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.Add(
'-Verbose', @{
2019-09-11 10:07:52 -04:00
'value' = '$PowerShell_Object_Verbose$';
'order' = '99';
}
);
$Basket.Command[$Data.Syntax.syntaxItem.Name].vars.Add(
2019-09-11 10:07:52 -04:00
'PowerShell_Object_Verbose', "0"
);
2019-09-11 10:07:52 -04:00
if ($Basket.Datafield.Values.varname -eq $IcingaCustomVariable) {
} else {
$Basket.Datafield.Add(
[string]$FieldID, @{
'varname' = 'PowerShell_Object_Verbose';
'caption' = 'Verbose';
'description' = $NULL;
'datatype' = 'Icinga\Module\Director\DataType\DataTypeDatalist';
'format' = $NULL;
'originalId' = [string]$FieldID;
'settings' = @{
'behavior' = 'strict';
'data_type' = 'string';
'datalist' = 'PowerShell Verbose'
}
}
);
2019-09-11 10:07:52 -04:00
}
}
if ($Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.ContainsKey('-NoPerfData') -eq $FALSE) {
$Basket.Command[$Data.Syntax.syntaxItem.Name].arguments.Add(
'-NoPerfData', @{
2019-09-11 10:07:52 -04:00
'set_if' = '$PowerShell_switch_NoPerfData$';
'set_if_format' = 'string';
'order' = '99';
}
);
$Basket.Command[$Data.Syntax.syntaxItem.Name].vars.Add(
2019-09-11 10:07:52 -04:00
'PowerShell_switch_NoPerfData', "0"
);
2019-09-11 10:07:52 -04:00
if ($Basket.Datafield.Values.varname -eq $IcingaCustomVariable) {
} else {
$Basket.Datafield.Add(
[string]$FieldID, @{
'varname' = 'PowerShell_switch_NoPerfData';
'caption' = 'Perf Data';
'description' = $NULL;
'datatype' = 'Icinga\Module\Director\DataType\DataTypeDatalist';
'format' = $NULL;
'originalId' = [string]$FieldID;
'settings' = @{
'behavior' = 'strict';
'data_type' = 'string';
'datalist' = 'PowerShell NoPerfData'
}
}
);
}
2019-09-11 10:07:52 -04:00
}
}
}
2019-09-13 02:18:31 -04:00
foreach ($check in $CheckName) {
[int]$FieldNumeration = 0;
if ($check -eq 'Invoke-IcingaCheckCommandBasket') {
} else {
$Data = (Get-Help $check)
foreach ($parameter in $Data.Syntax.syntaxItem.parameter){
$IcingaCustomVariable = [string]::Format('PowerShell_{0}_{1}', $parameter.type.name, $parameter.Name);
[hashtable]$translationdatafield = @{}
foreach ($DID in $Basket.Datafield.Keys)
{
$translationdatafield.Add($Basket.Datafield.$DID.varname, $DID);
}
# $translationdatafield.Add()
foreach($key in $translationdatafield.Keys)
{
if ([string]$IcingaCustomVariable -eq [string]$key)
{
$otherID = $translationdatafield[$IcingaCustomVariable];
} else {}
}
# Get Necessary Syntax-Information and more through cmdlet "Get-Help"
Write-Host $Data.Syntax.syntaxItem.Name
Write-Host $Parameter.Name
# [int]$FieldID = [int]$FieldID + 1;
$Basket.Command[$Data.Syntax.syntaxItem.Name].fields.Add(
[string]$FieldNumeration, @{
'datafield_id' = [int]$otherID;
'is_required' = $Required;
'var_filter' = $NULL;
}
);
[int]$FieldNumeration = [int]$FieldNumeration + 1;
}
}
}
if ($CheckName.Count -eq 1) {
$FileName = "${CheckName}.json";
} else {
$FileName = "Checks.json";
}
$output=ConvertTo-Json -D 100 $Basket > "$FileName";
$FilePath = (Get-Location).Path
# Output-Text
Write-Host "The following commands have been exported:"
foreach ($check in $CheckName) {
if ($check -ne "Invoke-IcingaCheckCommandBasket") {
Write-Host "- '$check'"
}
}
Write-Host "JSON export created in '${FilePath}\${FileName}'"
return $output;
}