Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/ninjaone/automations/bginfo-verify-scheduled-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
id: '012a3d2e-4524-4fd3-9705-81a2ef0ca253'
slug: /012a3d2e-4524-4fd3-9705-81a2ef0ca253
title: 'BGInfo - Verify Scheduled Task'
title_meta: 'BGInfo - Verify Scheduled Task'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'Checks whether the "BGInfo scheduled task" exists and is configured with a "logon trigger for any user"'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Overview

Checks whether the **Scheduled task - BGInfo** exists and is configured with a **At log on for any user** trigger.

## Sample Run

![Image1](../../../static/img/docs/012a3d2e-4524-4fd3-9705-81a2ef0ca253/image1.webp)

## Dependencies

- [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3)
- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)

## Automation Setup/Import

[Automation Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/scripts/bginfo-verify-scheduled-task.ps1)

## Output

- Activity Details

## Changelog

### 2026-09-28

- Initial version of the document
46 changes: 46 additions & 0 deletions docs/ninjaone/automations/configure-bginfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: '408cc622-de6a-4913-9150-267dcb4685e3'
slug: /408cc622-de6a-4913-9150-267dcb4685e3
title: 'Configure BGInfo'
title_meta: 'Configure BGInfo'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'Downloads and configures Microsoft Sysinternals BGInfo, applies the specified .BGI configuration file, and creates a scheduled task to run BGInfo automatically at user logon.'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Overview
Downloads and configures Microsoft Sysinternals BGInfo, applies the specified .BGI configuration file, and creates a scheduled task to run BGInfo automatically at user logon.

## Sample Run

![Image1](../../../static/img/docs/408cc622-de6a-4913-9150-267dcb4685e3/image1.webp)

## Dependencies

- [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d)
- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)


## Parameters

| Name | Example | Accepted Values | Required | Default | Type | Description |
| ---- | ------- | --------------- | -------- | ------- | ---- | ----------- |
| BGIName | `CompanyBGI.bgi`, `CompanyBGI.zip` | | True | - | string/text | Specify the name of the BGInfo configuration file to use. The parameter accepts either a `.bgi` configuration file or a `.zip` file containing a `.bgi` configuration with the other supported custom script that it executes like .vbs and should be applied to it. The specified file must be transferred to the `C:\ProgramData\_automation\app\BGInfo` location using Ninja's `BGI File` file transfer functionality [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d).|

## Automation Setup/Import

[Automation Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/scripts/configure-bginfo.ps1)

## Output

- Activity Details

## Changelog

### 2026-09-28

- Initial version of the document
40 changes: 40 additions & 0 deletions docs/ninjaone/compound-conditions/configure-bginfo-servers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
id: 'cebee064-7fcf-43ea-8792-e48a9d755ddd'
slug: /cebee064-7fcf-43ea-8792-e48a9d755ddd
title: 'Configure BgInfo - Servers'
title_meta: 'Configure BgInfo - Servers'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'Triggers the scripts to Configure BGInfo'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Summary
This condition triggers the [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d) and [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3) on Windows Servers where BGInfo deployment is enabled through the [Custom Field - cPVAL Configure BGInfo](/docs/4055f1a8-0faa-47f6-b476-e50973bc5a25).The condition also verifies that the "BGInfo scheduled task" has not already been created. This is validated using [Automation - BGInfo - Verify Scheduled Task](/docs/012a3d2e-4524-4fd3-9705-81a2ef0ca253).

## Details
- **Name:** `Configure BgInfo - Servers`
- **Description:** `This condition triggers the "File Transfer - BGI File" and "Automation - Configure BGInfo" on Windows Servers where BGInfo deployment is enabled through the "Custom Field - cPVAL Configure BGInfo". The condition also verifies that the "BGInfo scheduled task" has not already been created. This is validated using "Automation - BGInfo - Verify Scheduled Task".`
- **Recommended Agent Policies:** `Windows Server Policy`

## Dependencies

- [Automation - BGInfo - Verify Scheduled Task](/docs/012a3d2e-4524-4fd3-9705-81a2ef0ca253)
- [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d)
- [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3)
- [Custom Field - cPVAL Configure BGInfo](/docs/4055f1a8-0faa-47f6-b476-e50973bc5a25)
- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)


## Compound Condition Creation

- [Compound Condition Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/compound-conditions/configure-bginfo-servers.toml)

## Changelog

### 2026-09-28

- Initial version of the document
39 changes: 39 additions & 0 deletions docs/ninjaone/compound-conditions/configure-bginfo-workstations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: '8cc5ecd5-036e-4fb2-b07d-14e738289f8f'
slug: /8cc5ecd5-036e-4fb2-b07d-14e738289f8f
title: 'Configure BgInfo - Workstations'
title_meta: 'Configure BgInfo - Workstations'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'Triggers the scripts to Configure BGInfo'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Summary
This condition triggers the [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d) and [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3) on Windows workstations where BGInfo deployment is enabled through the [Custom Field - cPVAL Configure BGInfo](/docs/4055f1a8-0faa-47f6-b476-e50973bc5a25).The condition also verifies that the "BGInfo scheduled task" has not already been created. This is validated using [Automation - BGInfo - Verify Scheduled Task](/docs/012a3d2e-4524-4fd3-9705-81a2ef0ca253).

## Details
- **Name:** `Configure BgInfo - Workstations`
- **Description:** `This condition triggers the "File Transfer - BGI File" and "Automation - Configure BGInfo" on Windows workstations where BGInfo deployment is enabled through the "Custom Field - cPVAL Configure BGInfo". The condition also verifies that the "BGInfo scheduled task" has not already been created. This is validated using "Automation - BGInfo - Verify Scheduled Task".`
- **Recommended Agent Policies:** `Windows Workstation Policy`

## Dependencies

- [Automation - BGInfo - Verify Scheduled Task](/docs/012a3d2e-4524-4fd3-9705-81a2ef0ca253)
- [File Transfer - BGI File](/docs/3201c4cc-a76e-4df9-8195-8663a320964d)
- [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3)
- [Custom Field - cPVAL Configure BGInfo](/docs/4055f1a8-0faa-47f6-b476-e50973bc5a25)
- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)

## Compound Condition Creation

- [Compound Condition Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/compound-conditions/configure-bginfo-workstations.toml)

## Changelog

### 2026-09-28

- Initial version of the document
40 changes: 40 additions & 0 deletions docs/ninjaone/custom-fields/cpval-configure-bginfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
id: '4055f1a8-0faa-47f6-b476-e50973bc5a25'
slug: /4055f1a8-0faa-47f6-b476-e50973bc5a25
title: 'cPVAL Configure BGInfo'
title_meta: 'cPVAL Configure BGInfo'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'Custom Field to select the operating system(s) on which BGInfo should be configured.'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Summary
Custom Field to select the operating system(s) on which BGInfo should be configured.

## Details

| Label | Field Name | Definition Scope | Type | Option Value | Default Value | Required | Technician Permission | Automation Permission | API Permission |Custom Field Tab Name |
| ----- | ---------- | ---------------- | ---- | ------------ | ------------- | --------- | --------------------- | --------------------- | -------------- | ----------- |
| cPVAL Configure BGInfo | cpvalConfigureBginfo | `Organization`, `Location`, `Device` | drop-down | `Windows`, `Windows Workstations`, `Windows Servers`, `Disabled` | `Disabled` | False | Editable | Read/Write | Read/Write | BGInfo |

## Dependencies

- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)

## Custom Field Creation

- [Custom Field Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/custom-fields/cpval-configure-bginfo.toml)

## Sample Screenshot

![Image1](../../../static/img/docs/4055f1a8-0faa-47f6-b476-e50973bc5a25/image1.webp)

## Changelog

### 2026-09-28

- Initial version of the document
3 changes: 3 additions & 0 deletions docs/ninjaone/file-transfer/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Ninja One File Transfer Templates"
}
24 changes: 24 additions & 0 deletions docs/ninjaone/file-transfer/_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: 'New GUID'
slug: /New GUID
title: 'Filename'
title_meta: 'Filename'
keywords: []
description: ''
tags: []
draft: true
unlisted: false
last_update:
date: 2025-07-18
---

## Overview

## Dependencies

## Template Creation

[File Transfer](https://github.com/ProVal-Tech/ninjarmm/blob/main/file-transfer/_template.toml)


## Changelog
36 changes: 36 additions & 0 deletions docs/ninjaone/file-transfer/bgi-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: '3201c4cc-a76e-4df9-8195-8663a320964d'
slug: /3201c4cc-a76e-4df9-8195-8663a320964d
title: 'BGI File'
title_meta: 'BGI File'
keywords: ['bginfo', 'configuration', 'download', 'tool', 'script']
description: 'The purpose of this file transfer is to place the BGI file or BGI ZIP file so it can be used by Configure BGInfo automation'
tags: ['windows']
draft: false
unlisted: false
last_update:
date: 2026-09-28
---

## Overview

The purpose of this file transfer is to place the BGI file or BGI ZIP file at the location below so it can be used by [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3).

Both `.zip` and `.bgi` files are supported by the automation.

**Path Location:** `C:\ProgramData\_automation\app\BGInfo`

## Dependencies

- [Automation - Configure BGInfo](/docs/408cc622-de6a-4913-9150-267dcb4685e3)
- [Solution - Configure BgInfo](/docs/e6f8548f-1459-4f72-9d77-be33dc4d89a6)

## File Transfer Creation

[File Transfer](https://github.com/ProVal-Tech/ninjarmm/blob/main/file-transfer/bgi-file.toml)

## Changelog

### 2026-09-28

- Initial version of the document
Loading
Loading