PSNVIDIA.DLS

0.2505.3

public/Get-NVDLSLicenseServer.ps1

<#
    .SYNOPSIS
    Retrieves NVIDIA DLS license server details.
 
    .DESCRIPTION
    Retrieves NVIDIA DLS license server details.
 
    .PARAMETER Server
    Specifies the NVIDIA DLS service instance.
 
    .EXAMPLE
    Get-NVIDIADLSLicenseServer
 
    .EXAMPLE
    Get-NVIDIADLSLicenseServer -Server 'dls.fqdn'
 
    .NOTES
    Tested on NVIDIA DLS 3.5.0.
 
    .OUTPUTS
    [PSCustomObject].
 
    .LINK
    https://ui.licensing.nvidia.com/api-doc/dls-api-docs.html
#>

function Get-NVDLSLicenseServer {
    [CmdletBinding()]
    [OutputType([PSCustomObject])]    
    param (
        [Parameter(Mandatory = $false)]
        [ValidateNotNullOrEmpty()]
        [String]$Server     
    )

    begin {
        try {        
            $splat = @{}

            if ($PSBoundParameters.ContainsKey('Server')) {
                $splat.Add('Server', $Server)
            }

            $connection = Get-NVDLSConnection @splat

            $headers = @{
                'Authorization' = ('Bearer {0}' -f $connection.token)
            }

            $serviceInstanceUser = Get-NVDLSUser @splat

            $virtualGroupId = $serviceInstanceUser.userScope.virtualGroupId
            $licenseServerId = $serviceInstanceUser.userScope.licenseServerId
            $orgName = $serviceInstanceUser.orgName
        }
        catch {
            throw $_
        }
    }

    process {
        try {
            $uri = ('https://{0}/admin/v1/org/{1}/virtual-groups/{2}/license-servers/{3}' -f $connection.Server, $orgName, $virtualGroupId, $licenseServerId)

            $response = Invoke-RestMethod -Method Get -Uri $uri -Headers $headers

            if ($null -eq $response) {
                throw $_
            }

            $response.licenseServer
        }
        catch {
            Write-Error -Message ("Error encountered retrieving license server details: {0}" -f $Server, $_)
        }
    }

    end { }   
}