Register-DSLicense

2025-02-17

Register-DSLicense

SYNOPSIS

Register a new license

SYNTAX

__AllParameterSets

Register-DSLicense -Serial <string> [-AutoAssign] [-AsLegacyResponse] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Register a new license. For the server license, use the cmdlet Register-DSServerLicense. For the AutoAssign parameter, it will be ignored for modules, except the Gateway module. Some examples of modules: CyberArk Integration, Delinea Integration, and Privileged Access Management (PAM).

EXAMPLES

EXAMPLE

PS C:> Register-DSLicense -Serial XXXXX-XXXXX-XXXXX-XXXXX-XXXXX -AutoAssign

Add a new license with the AutoAssign set

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: ''

-AutoAssign

Auto assign new users. Ignored for modules, such as the PAM module.

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: ''

-Serial

Serial to add to the DVLS instance

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  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

RemoteDesktopManager.PowerShellModule.Private.ServerResponse

NOTES

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

RELATED LINKS