What is This?

This is a PowerShell integration for Contacts Database (CDB). This is the system of record for system/asset ownership.

How do I install it?

Install Powershell 7, you have options for this. Chocolatey or GitHub.
At this point you can install from the PSGallery for the latest stable build or continue with the steps to install from the repository.
Use the provided Makefile or manually copy the .\UofICDB folder to a valid PSModulePath directory. The Makefile will also install the UofIDMI module from the PSGallery.
The below will prompt you for credentials and then encrypts them on your machine at 'C:\Users$USERNAME\AppData\Local\PSCDBAuth2.txt' on Windows and '/home//.local/share/PSCDBAuth2.txt' on Linux
```
Import-Module UofICDB
New-CDBConnection -Save
```

How does it work?

You will initiate a connection to CDB with New-CDBConnection. Optionally storing your credentials. These will be API specific credentials and not your NetID.
Get-CDBItem will be the primary cmdlet at this point. This will be used to make queries and get information back.
Invoke-CDBRestCall is a generic way to make rest calls if you need to do something not supported by Get-CDBItem.
If you need a reference of SubClasses properties to craft a filter you can use Get-CDBSubClassSchema to get a listing back.

How do I help?

Ensure naming schemes are kept consistent with the Verb-CDBNoun convention.
Ensure the docs folder is kept up to date as well as the comment based help. The docs are generated via the PlatyPS.
Any new functionality should have associated pester tests added to the UofIDMI.Tests.ps1 file and by extension no PR should be accepted without passing pester tests.
Ensure that cross platform support is kept in mind. The actions are configured to test on Ubuntu as well as Windows.

Verbiage explained

owner_code: This is what CDB refers to the department or banner org code as.
SubClass: The archetype of an item, EX: Network, Building, System, etc.
Schema: The documented properties for items of a given SubClass. Schemas can be viewed with Get-CDBSubclassSchema and the information used to craft a filter for Get-CDBItem.

Use cases

Finding the network owner for a given IP address via pairing with the UofIDMI module.

#Single IP
Get-CDBItem -NetworkByHostIP '192.168.1.1' | Get-DMIDepartment

#Enumerate through logs to get statistics on which departments are using your service.
Import-CSV -Path '.\MyLogs.csv' | Foreach-Object -Process {Get-CDBItem -NetworkByHostIP $_.SourceIP} | 
   Group-Object -Property 'owner_code' | 
   Select-Object -Property 'Count', @{ Name = 'Deptname';  Expression = {($_.Name | Get-DMIDepartment).DeptName}}, 'Group'

Count Deptname
----- --------
   2 Engineering Administration
   2 Information Sciences