ConvertTo-NBRackMarkdown
Since
v4.4.10.0
SYNOPSIS
Convert rack elevation data to Markdown format
SYNTAX
ConvertTo-NBRackMarkdown [-RackName] <String> [[-SiteName] <String>] [[-UHeight] <Int32>] [[-Face] <String>]
[[-ElevationData] <PSObject[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Internal helper function that generates a GitHub-flavored markdown table representing a rack elevation diagram.
EXAMPLES
EXAMPLE 1
$elevation = Get-NBDCIMRackElevation -Id 24
ConvertTo-NBRackMarkdown -RackName "DC1-R01" -SiteName "Amsterdam" -UHeight 42 -Face Front -ElevationData $elevation
Generates a GitHub-flavored markdown table showing rack elevation.
EXAMPLE 2
$elevation = Get-NBDCIMRackElevation -Id 24 | Where-Object { $_.device }
ConvertTo-NBRackMarkdown -RackName "DC1-R01" -SiteName "Amsterdam" -UHeight 42 -Face Front -ElevationData $elevation | Out-File rack.md -Encoding utf8
Generates markdown for only occupied rack units and saves to file.
PARAMETERS
-RackName
Display name of the rack
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-SiteName
Display name of the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-UHeight
Total height of the rack in U
```yaml Type: Int32 Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: 42 Accept pipeline input: False Accept wildcard characters: False ```
-Face
Face being displayed (Front or Rear)
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: Front Accept pipeline input: False Accept wildcard characters: False ```
-ElevationData
Array of elevation unit objects from Get-NBDCIMRackElevation
```yaml Type: PSObject[] Parameter Sets: (All) Aliases:
Required: False Position: 5 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.String
NOTES
AddedInVersion: v4.4.10.0 This is an internal helper function. Use Export-NBRackElevation -Format Markdown for the public interface.