Get-BluGenieServiceStatus

SYNOPSIS
Report on the Status of the BluGenie Windows Service
SYNTAX
      Get-BluGenieServiceStatus [-Walkthrough] [-ReturnObject] [-OutUnEscapedJSON] [-OutYaml] [[-FormatView] <String>] [<CommonParameters>]
​
    
DESCRIPTION
Report on the Status of the BluGenie Windows Service
Report includes
Jobs that are currently waiting to run
Processing Jobs
Completed Jobs
Completed JSON reports
Service State
Service CPU Resources
Service Memory Resources
BluGenie Service Event Viewer Logs
EXAMPLES
EXAMPLE 1
      Command: Get-BluGenieServiceStatus
​
    
      Description: Report on the Status of the BluGenie Windows Service
Notes:
​
    
EXAMPLE 2
      Command: Get-BGServiceStatus
​
    
      Description: Use the Alias to report on the Status of the BluGenie Windows Service
Notes:
​
    
EXAMPLE 3
      Command: Get-BluGenieServiceStatus -Help
​
    
      Description: Call Help Information
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter
​
    
EXAMPLE 4
      Command: Get-BluGenieServiceStatus -WalkThrough
​
    
      Description: Call Help Information [2]
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter
​
    
EXAMPLE 5
      Command: Get-BGServiceStatus -OutUnEscapedJSON
​
    
      Description: Return a detailed function report in an UnEscaped JSON format
Notes:  The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters.  Normal return data is a Hash Table.
​
    
EXAMPLE 6
      Command: Get-BGServiceStatus -OutYaml
​
    
      Description: Return a detailed function report in YAML format
Notes:  The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters.  Normal return data is a Hash Table.
​
    
EXAMPLE 7
      Command: Get-BGServiceStatus -ReturnObject
​
    
      Description: Return Output as a Object
Notes:  The ReturnObject is used to return a PowerShell Object.  Normal return data is a Hash Table.
       This parameter is also used with the ForMat
​
    
EXAMPLE 8
      Command: Get-BluGenieServiceStatus -ReturnObject -FormatView Yaml
​
    
      Description: Output PSObject information in Yaml format
Notes:  Current formats supported by default are ('Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml')
       Default is set to (None) and normal PSObject.
​
    
PARAMETERS
Walkthrough
      -Walkthrough [<SwitchParameter>]
   Description:  Start the dynamic help menu system to help walk through the current command and all of the parameters
   Notes:
   Alias: Help
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
​
    
ReturnObject
      -ReturnObject [<SwitchParameter>]
   Description: Return information as an Object
   Notes: By default the data is returned as a Hash Table
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
​
    
OutUnEscapedJSON
      -OutUnEscapedJSON [<SwitchParameter>]
   Description: Remove UnEsacped Char from the JSON information.
   Notes: This will beautify json and clean up the formatting.
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
​
    
OutYaml
      -OutYaml [<SwitchParameter>]
   Description: Return detailed information in Yaml Format
   Notes: Only supported in Posh 3.0 and above
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
​
    
FormatView
      -FormatView <String>
   Description: Automatically format the Return Object
   Notes: Yaml is only supported in Posh 3.0 and above
   Alias:
   ValidateSet: 'Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml'
   
   Required?                    false
   Position?                    1
   Default value                None
   Accept pipeline input?       false
   Accept wildcard characters?  false
​
    
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Get-BluGenieServiceList
Get-BluGenieSessionAliasList
Last modified 1yr ago