Manage Icinga Agent Features¶
The Icinga PowerShell Framework is shipping wish a bunch of Cmdlets to manage the Icinga Agent in a very easy way. This includes the managing for features enabled or disabled for the Icinga Agent.
Note: Before using any of the commands below you will have to initialize the Icinga PowerShell Framework inside a new PowerShell instance with icinga -Shell
List Icinga Agent Features¶
To view a list of currently enabled and disabled features, you can use the command Get-IcingaAgentFeatures
:
Get-IcingaAgentFeatures;
Name Value
---- -----
Disabled {api, checker, debuglog, elasticsearch...}
Enabled {mainlog}
For a full list you can directly access each object:
(Get-IcingaAgentFeatures).Disabled;
api
checker
debuglog
elasticsearch
gelf
graphite
influxdb
notification
opentsdb
perfdata
(Get-IcingaAgentFeatures).Enabled;
mainlog
Enable Icinga Agent Features¶
To simply enable an Icinga Agent feature you can use Enable-IcingaAgentFeature
followed by the name of the feature. In case the feature is already enabled, you will receive a notification and no change will be made:
Enable-IcingaAgentFeature -Feature api;
[Notice]: Feature "api" was successfully enabled
In case the feature is already enabled:
[Notice]: This feature is already enabled [api]
Now restart your Icinga Agent to take the changes into effect:
Restart-IcingaService icinga2
[Notice]: Restarting service "icinga2"
Disable Icinga Agent Features¶
To simply disable an Icinga Agent feature you can use Disable-IcingaAgentFeature
followed by the name of the feature. In case the feature is already disabled, you will receive a notification and no change will be made:
Disable-IcingaAgentFeature -Feature api;
[Notice]: Feature "api" was successfully disabled
In case the feature is already enabled:
[Notice]: This feature is already disabled [api]
Now restart your Icinga Agent to take the changes into effect:
Restart-IcingaService icinga2
[Notice]: Restarting service "icinga2"