Get-DSLicense

    2024-11-18

    Get-DSLicense

    SYNOPSIS

    Get all licenses, except the server one

    SYNTAX

    __AllParameterSets

    Get-DSLicense [-AsLegacyResponse] [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get all licenses, except the server one. To obtain the users who have been assigned to a specific license, use the cmdlet Get-DSUserLicense.

    EXAMPLES

    EXAMPLE 1

    PS C:> $licenses = Get-DSLicence

    Obtain all licenses, except the server one

    EXAMPLE 2

    PS C:> $licResponse = Get-DSLicence -AsLegacyResponse; $licRespones.Data | Where -Property Status -eq Expired | Unregister-DSLicense

    Remove all expired licenses

    EXAMPLE 3

    PS C:> $licResponse = Get-DSLicence; $license = $licRespones.Data | Where -Property License -like XXXXX* | Select -First 1 $assignResponse = Get-DSUserLicense -InputObject $license $assignments = $assignResponse.Data $aUserAssignment = $asssignments | Where Name -eq 'Name of the user to assign' $aUserAssignment.IsMember = $true Set-DSUserLicense -InputObject $aUserAssignment

    Assign the license starting with XXXXX to the user 'Name of the user to assign'

    PARAMETERS

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

    Type: System.Management.Automation.SwitchParameter
    DefaultValue: ''
    SupportsWildcards: false
    ParameterValue: []
    Aliases: []
    ParameterSets:
    - Name: (All)
      Position: Named
      IsRequired: false
      ValueFromPipeline: false
      ValueFromPipelineByPropertyName: false
      ValueFromRemainingArguments: false
    DontShow: false
    AcceptedValues: []
    HelpMessage: ''
    

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    OUTPUTS

    NOTES

    For more information, type "Get-Help Get-DSLicense -detailed". For technical information, type "Get-Help Get-DSLicense -full".