Skip to content

Export-NBRackElevation

Since

v4.4.10.0

SYNOPSIS

Export rack elevation visualization to HTML, Markdown, or SVG

SYNTAX

Export-NBRackElevation [-Id] <UInt64> [[-Format] <String>] [[-Face] <String>] [[-Path] <String>]
 [-UseNativeRenderer] [-IncludeEmptySlots] [-Compact] [-NoColor] [-PassThru] [-Force]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Generates rack elevation visualizations in various formats: - HTML: Standalone HTML page with styled rack table - Markdown: GitHub-flavored markdown table - SVG: Native Netbox SVG rendering (passthrough)

Supports pipeline input from Get-NBDCIMRack for batch exports.

EXAMPLES

EXAMPLE 1

Export-NBRackElevation -Id 24 -Format HTML -Path "./rack.html"

Exports rack 24 as HTML file

EXAMPLE 2

Export-NBRackElevation -Id 24 -Format Markdown

Returns markdown table as string

EXAMPLE 3

Get-NBDCIMRack -Site "Amsterdam" | Export-NBRackElevation -Format HTML -Path "./racks/"

Exports all racks in Amsterdam site to HTML files

EXAMPLE 4

Export-NBRackElevation -Id 24 -Format SVG -UseNativeRenderer -Path "./rack.svg"

Saves native Netbox SVG rendering

EXAMPLE 5

Export-NBRackElevation -Id 24 -Format Console

Displays ASCII-art rack elevation in the terminal

EXAMPLE 6

Export-NBRackElevation -Id 24 -Format Console -Compact -NoColor

Compact console output without colors (for piping/logging)

PARAMETERS

-Id

The ID of the rack to export (required, pipeline support)

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Format

Output format: HTML (default), Markdown, SVG, or Console

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: HTML
Accept pipeline input: False
Accept wildcard characters: False

-Face

Which face of the rack to show: Front (default), Rear, or Both

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: Front
Accept pipeline input: False
Accept wildcard characters: False

-Path

Output file path. If a directory, filename is auto-generated. If not specified, content is returned as string.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseNativeRenderer

Use Netbox's built-in SVG renderer instead of custom HTML/Markdown. Only applies to SVG and HTML formats.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeEmptySlots

Include all empty U positions in output. Default shows only occupied.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Compact

For Console format: hide empty slots and show summary instead.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NoColor

For Console format: disable ANSI color codes.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return content as string instead of writing to file (even when -Path specified)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

Overwrite existing files without confirmation

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.

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.

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 }}

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.String

System.Void

NOTES

AddedInVersion: v4.4.10.0

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/models/dcim/rack/