# Set-BluGenieTrapping

﻿Set-BluGenieTrapping

### SYNOPSIS <a href="#synopsis" id="synopsis"></a>

Set-BluGenieTrapping is an add-on to control Remote Host log trapping in the BluGenie Console

### SYNTAX <a href="#syntax" id="syntax"></a>

```
Set-BluGenieTrapping [-SetTrue] [-SetFalse] [-Walkthrough] [<CommonParameters>]
```

### DESCRIPTION <a href="#description" id="description"></a>

Set-BluGenieTrapping is an add-on to control Remote Host log trapping in the BluGenie Console.

Trap information is captured to both a file and the Event Log. o FilePath = <$env:SystemDrive>\Windows\Temp\BG<$JobID>-<$PID>-<10\_Digit\_GUID>.log o Event Info: \~ EventLogName = 'Application' \~ Source = 'BluGenie' \~ EntryType = 'Information' \~ EventID = 7114 o Data captured using Posh 2 \~ Data will be logged using ConvertTo-Xml -as String o Data captured using Posh 3 and Above \~ Data will be logged using ConvertTo-JSON

Information Trapped: o JobID o Hostname o Commands o ParallelCommands o PostCommands o FullDumpPath

Command Alias: o Set-BGTrap o SetTrap o Trap (For Help Only - "Trap" is a Posh Built-In Command)

### EXAMPLES <a href="#examples" id="examples"></a>

#### EXAMPLE 1 <a href="#example-1" id="example-1"></a>

```
Command: Set-BluGenieTrapping
```

```
Description: This will toggle the Trap indicator from (True to False) or (False to True)
Notes:
Output:
```

#### EXAMPLE 2 <a href="#example-2" id="example-2"></a>

```
Command: Set-BluGenieTrapping -SetTrue
```

```
Description: This will set the Trap indicator to True
Notes:
Output:
```

#### EXAMPLE 3 <a href="#example-3" id="example-3"></a>

```
Command: Set-BluGenieTrapping -SetFalse
```

```
Description: This will set the Trap indicator to False
Notes:
Output:
```

### PARAMETERS <a href="#parameters" id="parameters"></a>

#### SetTrue <a href="#settrue" id="settrue"></a>

```
-SetTrue [<SwitchParameter>]
   Description: Set Trapping Information Flag to $true
   Notes:
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### SetFalse <a href="#setfalse" id="setfalse"></a>

```
-SetFalse [<SwitchParameter>]
   Description: Set Trapping Information Flag to $false
   Notes:
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### Walkthrough <a href="#walkthrough" id="walkthrough"></a>

```
-Walkthrough [<SwitchParameter>]
   Description: An automated process to walk through the current function and all the parameters
   Notes:
   Alias:
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false
```

#### CommonParameters <a href="#commonparameters" id="commonparameters"></a>

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/set-blugenietrapping.md?ask=<question>
```

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.
