Get-RDMAddOnId

Synopsis

Retrieves the ID of a specified add-on by name. If no name is provided, returns a hashtable mapping all add-on names to their corresponding IDs.

Syntax

__AllParameterSets

Get-RDMAddOnId [[-Name] <string>] [<CommonParameters>]

Description

Retrieves the ID of a specified add-on by name. If no name is provided, returns a hashtable mapping all add-on names to their corresponding IDs. Each add-on's ID is stored in the ConnectionSubType property of its entry. The list includes all add-ons, regardless of activation status.

Examples

Example 1

PS C:\> $addon = New-RDMEntry -Name AddOnWinbox -Type AddOn
PS C:\> $addOn.AddOn.Host = '123.123.123.123'
PS C:\> $addOn.AddOn.Username = 'myUserName'
PS C:\> $addOn.ConnectionSubType = (Get-RDMAddOnId -Name Winbox)
PS C:\> Set-RDMEntryPassword -InputObject $addOn -Password $someSecureString
PS C:\> Set-RDMEntry -InputObject $addOn -Refresh

Create a Mikrotik Winbox entry.

Example 2

PS C:\> $addonNameToIdMapping = Get-RDMAddOnId
PS C:\> $addOnIdToNameMapping = @{}
PS C:\> foreach ($name in $addOnNameToIdMapping.Keys) {
  $id = $addOnNameToIdMapping[$name]
  $addOnIdToNameMapping[$id] = $name
}
PS C:\> $addonsGrouped = Get-RDMEntry -Type AddOn | Group-Object ConnectionSubType
PS C:\> $result = foreach ($group in $addonsGrouped) {
    $type = $group.Name
    $count = $group.Count
    $name = $addOnIdToNameMapping[$type]

[PSCustomObject]@{
    Name  = $name
    Count = $count
}

}

PS C:\> $result

Count the usage for each add-on types.

Parameters

-Name

AddOn application name without spaces

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

Notes

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