Installation
Prerequisites
- Requires PowerShell Core (recommended), or Windows PowerShell (version 5.1)
- A RadiantOne deployment or SaaS tenant
- An account with permission to access the RadiantOne API
Install Options
Users can install psRadiantOne from GitHub or the PowerShell Gallery.
Choose any of the following ways to download the module and install it:
Option 1: Install from PowerShell Gallery
This is the easiest and most popular way to install the module:
-
Open a PowerShell prompt
-
Run the following command:
Install-Module -Name psRadiantOne -Scope CurrentUser
Option 2: Manual Install
The module files can be manually copied to one of your PowerShell module directories.
Use the following command to get the paths to your local PowerShell module folders:
$env:PSModulePath.split(';')
The module files must be placed in one of the listed directories, in a folder called psRadiantOne.
More: about_PSModulePath
The module files are available to download using a variety of methods:
PowerShell Gallery
- Download the module from the PowerShell Gallery:
- Run the PowerShell command
Save-Module -Name psRadiantOne -Path C:\temp - Copy the
C:\temp\psRadiantOnefolder to your “Powershell Modules” directory of choice.
- Run the PowerShell command
psRadiantOne Release
- Download the latest GitHub release
- Unblock & Extract the archive
- Rename the extracted
psRadiantOne-v#.#.#folder topsRadiantOne - Copy the
psRadiantOnefolder to your “Powershell Modules” directory of choice.
psRadiantOne Branch
- Download the
mainbranch- Unblock & Extract the archive
- Copy the
psRadiantOne(\<Archive Root>\psRadiantOne-main\psRadiantOne) folder to your “Powershell Modules” directory of choice.
Verification
Validate Install:
Get-Module -ListAvailable psRadiantOne
Import the module:
Import-Module psRadiantOne
List Module Commands:
Get-Command -Module psRadiantOne
Get detailed information on specific commands:
Get-Help Connect-R1Session -Full