Connect-GreenRadiusAPI.ps1
|
function Connect-GreenRadiusAPI { <# .NOTES Version 2026.3.13.1331 .SYNOPSIS Collects GreenRADIUS server information for use in subsequent calls to the API. .DESCRIPTION Configures the given Powershell session to be able to make GreenRADIUS API calls. This function is necessary for subsequent calls to most other functions in this module. .OUTPUTS No outputs. Note that this does no checking on its own; any failures (bad password, bad address, etc.) will not be made apparent until subsequent use of the other functions. .PARAMETER Hostname The hostname to use to try to connect to the GreenRADIUS server API. While this does support an array of strings, and therefore multiple servers, most functions within this module will only use the first one specified. .PARAMETER Username The username to use to connect to the API. Defaults to "grsapiusr" .PARAMETER Password The password to attempt to use with the API. .PARAMETER DefaultDomain If present, most other functions which accept usernames as arguments will, if no domain is specified for a given user (no @ symbol) will automatically append the domain specified here. If no domain is specified, then the domain name to which the current computer is joined to will be used by default. .PARAMETER RateLimitPauseTime Time, in seconds, for the script to pause if the GreenRADIUS server is rate-limiting us. The operation which triggered the rate limiting will be retried. Default value is 30. #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] [string[]]$Hostname="", [string]$Username="grsapiusr", [Parameter(Mandatory=$true)] [securestring]$Password, [string]$DefaultDomain, [ValidateRange(1, [int]::MaxValue)] [int]$RateLimitPauseTime=30 ) if ($global:GreenRadiusApiSession) { Disconnect-GreenRadiusAPI } $Credential = New-Object System.Management.Automation.PSCredential($Username, $Password) if (-not $DefaultDomain) { $DefaultDomain = (Get-CimInstance Win32_ComputerSystem).Domain } $global:GreenRadiusApiSession = @{ Hostname = $Hostname Credential = $Credential DefaultDomain = $DefaultDomain RateLimitPauseTime = $RateLimitPauseTime } SubmitGreenRadiusApiCall ` -Server $global:GreenRadiusApiSession.Hostname ` -Uri "/gras-api/v2/mgmt/temporary-tokens" ` -Method Head -MultiServer | Out-Null return $null } <# LICENSE Copyright (c) 2026 Derek Howard and the City of Eureka, California Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, and/or distribute copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software, and the original author shall be credited as having created the original work. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> |