# Invoke-BluGenieProcess ### Invoke-BluGenieProcess ### SYNOPSIS Invoke-BluGenieProcess will kick off the multi threaded job management engine ### SYNTAX ``` Invoke-BluGenieProcess [[-System] ] [-Command ] [-JobID ] [-ThreadCount ] [-Walkthrough] [-Trap] [-JobTimeout ] [-WhatIf] [-Confirm] [] Invoke-BluGenieProcess [-Range ] [[-Command] ] [[-JobID] ] [-ThreadCount ] [-Walkthrough] [-Trap] [-JobTimeout ] [-WhatIf] [-Confirm] [] ``` ### DESCRIPTION Invoke-BluGenieProcess will kick off the multi threaded job management engine ### EXAMPLES #### EXAMPLE 1 ``` Invoke-BluGenieProcess -System 'Computer1' -Command 'Get-SystemInfo' -JobID '12345' ``` ``` This will run the command (Get-SystemInfo) on the remote system "Computer1". All data will be logged in a directory with the assigned JOBID as the name. ``` #### EXAMPLE 2 ``` Invoke-BluGenieProcess -Range 10.10.1.50-10.10.1.250 -Command 'Get-SystemInfo' ``` ``` This will run the command (Get-SystemInfo) on all systems in the IP range of [10.10.1.50 -> 250]. All data will be logged in a directory with the assigned Date and Time. ``` #### EXAMPLE 3 ``` Invoke-BluGenieProcess -System 'Computer1' -Command 'Get-SystemInfo' -Trap ``` ``` This will run the command (Get-SystemInfo) on the remote system "Computer1". The job data will also be trapped and logged on the remote hosts Event log. Event Log Details: LogName = Application Source = BluGenie Type = Information ID = 7114 ``` #### EXAMPLE 4 ``` Run -System 'Computer1' -Command 'Get-SystemInfo' -JobTimeout 5 ``` ``` This will run the command (Get-SystemInfo) on the remote system "Computer1". The job has a timed session of 5 minutes. After that the session will be automatically closed. Note: If a job has reached it's timeout value, the session is closed and no data is captured unless you use the -Trap parameter. The -Trap parameter will log all the data on the remote host's Drive. ``` ### PARAMETERS #### System ``` -System Computer Name or IP Address of the System you want to manage String Required? false Position? 1 Default value $( If (-Not $global:ConsoleSystems) { [System.Collections.ArrayList]$global:ConsoleSystems = @() } Return $global:ConsoleSystems ) Accept pipeline input? true (ByValue, ByPropertyName) Accept wildcard characters? false ``` #### Range ``` -Range IP Address Range of the Systems you want to manage String Required? false Position? named Default value $( If (-Not $global:ConsoleRange) { [System.Collections.ArrayList]$global:ConsoleRange = @() } Return $global:ConsoleRange ) Accept pipeline input? false Accept wildcard characters? false ``` #### Command ``` -Command The Commands you would like to execute on the remote computer String Required? false Position? named Default value $( If (-Not $global:ConsoleCommands) { [System.Collections.ArrayList]$global:ConsoleCommands = @() } Return $global:ConsoleCommands ) Accept pipeline input? false Accept wildcard characters? false ``` #### JobID ``` -JobID The Job Identifier String Required? false Position? named Default value $( If (-Not $global:ConsoleJobID) { [String]$global:ConsoleJobID = '' } Return $global:ConsoleJobID ) Accept pipeline input? false Accept wildcard characters? false ``` #### ThreadCount ``` -ThreadCount How many remote systems do you want to control at once. The default is ( 50 ) Int Required? false Position? named Default value $( If (-Not $global:ConsoleThreadCount) { [Int]$global:ConsoleThreadCount = 50 } Return $global:ConsoleThreadCount ) Accept pipeline input? false Accept wildcard characters? false ``` #### Walkthrough ``` -Walkthrough [] An automated process to walk through the current function and all the parameters SwitchParameter Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### Trap ``` -Trap [] Trap the return data in the Windows Event Log SwitchParameter Required? false Position? named Default value $( If (-Not $global:ConsoleTrap) { [Switch]$global:ConsoleTrap = $false } Return $global:ConsoleTrap ) Accept pipeline input? false Accept wildcard characters? false ``` #### JobTimeout ``` -JobTimeout How long a remote systems connection can stay open before it is automatically closed. The default is ( 120 min ) Note: If a job has reached it's timeout value, the session is closed and no data is captured unless you use the -Trap parameter. The -Trap parameter will log all the data on the remote host's Drive. Int Required? false Position? named Default value $( If (-Not $global:ConsoleJobTimeout) { [Int]$global:ConsoleJobTimeout = 120 } Return $global:ConsoleJobTimeout ) Accept pipeline input? false Accept wildcard characters? false ``` #### WhatIf ``` -WhatIf [] Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false ``` #### Confirm ``` -Confirm [] Required? false Position? named Default value 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](http://go.microsoft.com/fwlink/?LinkID=113216). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://manuals.blusapphire.io/blugenie/full-function-list/invoke-blugenieprocess.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.