New-NBCustomLink
Since
v4.4.10.0
SYNOPSIS
Creates a new custom link in Netbox.
SYNTAX
New-NBCustomLink [-Name] <String> [-Object_Types] <String[]> [[-Enabled] <Boolean>] [-Link_Text] <String>
[-Link_Url] <String> [[-Weight] <UInt16>] [[-Group_Name] <String>] [[-Button_Class] <String>]
[[-New_Window] <Boolean>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new custom link in Netbox Extras module.
EXAMPLES
EXAMPLE 1
New-NBCustomLink -Name "External Doc" -Object_Types @("dcim.device") -Link_Text "View Docs" -Link_Url "https://docs.example.com/{{ object.name }}"
PARAMETERS
-Name
Name of the custom link.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Object_Types
Object types this link applies to.
```yaml Type: String[] Parameter Sets: (All) Aliases:
Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Enabled
Whether the link is enabled.
```yaml Type: Boolean Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Link_Text
Link text (Jinja2 template).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Link_Url
Link URL (Jinja2 template).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Weight
Display weight.
```yaml Type: UInt16 Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Group_Name
Group name for organizing links.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Button_Class
Button CSS class.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-New_Window
Whether to open in new window.
```yaml Type: Boolean Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: Object[] Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Confirm
Prompts you for confirmation before running the cmdlet.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-ProgressAction
{{ Fill ProgressAction Description }}
```yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Management.Automation.PSObject
NOTES
AddedInVersion: v4.4.10.0