Crestron-Site-Audit

---

---

A PowerShell script to audit a Crestron Site.

Contents 📖

• Features ✅
• Getting Started 🚀
  • Prerequisites
  • Create Encryption Key
  • Create Manifest File
• Usage ⚡
• Team ⚽
• Contributing ✨
• LICENSE ⚖️

Features ✅

• ✅ Device Version Information
• ✅ Device Program Information
• ✅ Device IP Table Information
• ✅ Device Cresnet Information
• ✅ Device Control Subnet Information
• ✅ Device AutoDiscovery Information
• ✅ Device Runtime Information
• ✅ Optional: Device File Backup

Getting Started 🚀

Prerequisites

Create Encryption Key

Credentials are encrypted using AES256. You must first create a key. This key is used to encrypt and decrypt the credentials. The key is not stored in the manifest file. The key must be stored in a .env file in the same directory as the script. The key must be stored in the AES_KEY variable. A sample file, .env.sample is provided in the repository.

1. Copy sample file to .env

cp .env.sample .env

2. Create and enter AES key

AES_KEY=cowbell

The longer and more complex the key, the better.

3. Keep the .env file secret

The .env file should be kept secret. It should not be committed to source control. It's recommended to add the file to your .gitignore file.

Create Manifest File

Create a manifest file with the following format:

{
    "credentials": [
        {
            "id": "guid",
            "name": "Friendly Name",
            "credential": "Aes256 Encrypted Credential"
        },
        {
            "id": "guid",
            "name": "Friendly Name",
            "credential": "Aes256 Encrypted Credential"
        }
    ],
    "devices": [
        {
            "address": "10.0.1.10",
            "secure": true,
            "credentialId": "guid"
        },
        {
            "address": "dev-hostname-02",
            "secure": false,
            "credentialId": ""
        },
        {
            "address": "dev-hostname-03",
            "secure": true,
            "credentialId": "guid"
        }
    ]
}

Usage ⚡

.\CrestronSiteAudit.ps1

Team ⚽

This project is maintained by the following person(s) and a bunch of awesome contributors.

Damien Butt

Contributing ✨

Contributions of any kind are welcome!

Check out the contributing guide for more information.

LICENSE ⚖️

MIT