mirror of
https://github.com/Icinga/icinga-powershell-framework.git
synced 2025-12-20 23:00:35 -05:00
Adds documentation for several Cmdlets
This commit is contained in:
Lord Hepipud
parent
429db105a8
commit
9e7ab31608
6 changed files with 115 additions and 0 deletions
|
|
@ -1,3 +1,16 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Disables the debug mode of the Framework
|
||||
.DESCRIPTION
|
||||
Disables the debug mode of the Framework
|
||||
.FUNCTIONALITY
|
||||
Disables the Icinga for Windows Debug-Log
|
||||
.EXAMPLE
|
||||
PS>Disable-IcingaFrameworkDebugMode;
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
#>
|
||||
|
||||
function Disable-IcingaFrameworkDebugMode()
|
||||
{
|
||||
$global:IcingaDaemonData.DebugMode = $FALSE;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,18 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Enables the debug mode of the Framework to print additional details into
|
||||
the Windows Event Log with Id 1000
|
||||
.DESCRIPTION
|
||||
Enables the debug mode of the Framework to print additional details into
|
||||
the Windows Event Log with Id 1000
|
||||
.FUNCTIONALITY
|
||||
Enables the Icinga for Windows Debug-Log
|
||||
.EXAMPLE
|
||||
PS>Enable-IcingaFrameworkDebugMode;
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
#>
|
||||
|
||||
function Enable-IcingaFrameworkDebugMode()
|
||||
{
|
||||
$global:IcingaDaemonData.DebugMode = $TRUE;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,20 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Function to fetch the last executed plugin peformance data
|
||||
from an internal memory cache in case the Framework is running as daemon.
|
||||
.DESCRIPTION
|
||||
While running the Framework as daemon, checkresults for plugins are not
|
||||
printed into the console but written into an internal memory cache. Once
|
||||
a plugin was executed, use this function to fetch the plugin performance data
|
||||
.FUNCTIONALITY
|
||||
Returns the last performance data output for executed plugins while the
|
||||
Framework is running as daemon
|
||||
.OUTPUTS
|
||||
System.Object
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
#>
|
||||
|
||||
function Get-IcingaCheckSchedulerPerfData()
|
||||
{
|
||||
if ($null -eq $IcingaDaemonData) {
|
||||
|
|
|
|||
|
|
@ -1,3 +1,20 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Function to fetch the last executed plugin output from an internal memory
|
||||
cache in case the Framework is running as daemon.
|
||||
.DESCRIPTION
|
||||
While running the Framework as daemon, checkresults for plugins are not
|
||||
printed into the console but written into an internal memory cache. Once
|
||||
a plugin was executed, use this function to fetch the plugin output
|
||||
.FUNCTIONALITY
|
||||
Returns the last checkresult output for executed plugins while the
|
||||
Framework is running as daemon
|
||||
.OUTPUTS
|
||||
System.Object
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
#>
|
||||
|
||||
function Get-IcingaCheckSchedulerPluginOutput()
|
||||
{
|
||||
if ($null -eq $IcingaDaemonData) {
|
||||
|
|
|
|||
|
|
@ -1,3 +1,18 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Get the current debug mode configuration of the Framework
|
||||
.DESCRIPTION
|
||||
Get the current debug mode configuration of the Framework
|
||||
.FUNCTIONALITY
|
||||
Get the current debug mode configuration of the Framework
|
||||
.EXAMPLE
|
||||
PS>Get-IcingaFrameworkDebugMode;
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
.OUTPUTS
|
||||
System.Boolean
|
||||
#>
|
||||
|
||||
function Get-IcingaFrameworkDebugMode()
|
||||
{
|
||||
$DebugMode = Get-IcingaPowerShellConfig -Path 'Framework.DebugMode';
|
||||
|
|
|
|||
|
|
@ -1,3 +1,41 @@
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Installs a PowerShell Module within the 'icinga-powershell-' namespace
|
||||
from GitHub or custom locations and installs it into the module directory
|
||||
the Framework itself is installed to
|
||||
.DESCRIPTION
|
||||
Installs a PowerShell Module within the 'icinga-powershell-' namespace
|
||||
from GitHub or custom locations and installs it into the module directory
|
||||
the Framework itself is installed to
|
||||
.FUNCTIONALITY
|
||||
Download and install a PowerShell module from the 'icinga-powershell-' namespace
|
||||
.EXAMPLE
|
||||
PS>Install-IcingaFrameworkComponent -Name 'plugins' -Stable;
|
||||
.EXAMPLE
|
||||
PS>Install-IcingaFrameworkComponent -Name 'plugins' -Stable -DryRun;
|
||||
.PARAMETER Name
|
||||
The name of the module to install. The namespace 'icinga-powershell-' is added
|
||||
by the function automatically
|
||||
.PARAMETER GitHubUser
|
||||
Overwrite the default GitHub user for a different one to download modules from
|
||||
.PARAMETER Url
|
||||
Specify a direct Url to a ZIP-Archive for external or local web ressources or
|
||||
local network shares
|
||||
.PARAMETER Stable
|
||||
Download the latest stable version from a GitHub source
|
||||
.PARAMETER Snapshot
|
||||
Download the latest master branch from a GitHub source
|
||||
.PARAMETER DryRun
|
||||
Only fetch possible Urls and return the result. No download or installation
|
||||
will be done
|
||||
.INPUTS
|
||||
System.String
|
||||
.OUTPUTS
|
||||
System.Hashtable
|
||||
.LINK
|
||||
https://github.com/Icinga/icinga-powershell-framework
|
||||
#>
|
||||
|
||||
function Install-IcingaFrameworkComponent()
|
||||
{
|
||||
param(
|
||||
|
|
|
|||
Loading…
Reference in a new issue