Skip to content

New-NBDCIMModuleBayType

Since

v4.7.0.1

SYNOPSIS

Creates a new Module Bay Type in Netbox DCIM module.

SYNTAX

New-NBDCIMModuleBayType [-Name] <String> [[-Slug] <String>] [[-Manufacturer] <UInt64>] [[-Color] <String>]
 [[-Description] <String>] [[-Owner] <UInt64>] [[-Comments] <String>] [[-Tags] <Object[]>]
 [[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Creates a new Module Bay Type in Netbox DCIM module (NetBox 4.7+). A module bay type describes which kinds of modules a module bay accepts. Assign it to module bays, module bay templates and module types via their -Module_Bay_Types parameter.

EXAMPLES

EXAMPLE 1

New-NBDCIMModuleBayType -Name 'SFP Cage' -Color '00ff00'

Creates a module bay type named 'SFP Cage' with slug 'sfp-cage'.

EXAMPLE 2

New-NBDCIMModuleBayType -Name 'Line Card Slot' -Slug 'lc-slot' -Manufacturer 3

Creates a manufacturer-specific module bay type with an explicit slug.

PARAMETERS

-Name

Name of the module bay type.

Type: String
Parameter Sets: (All)
Aliases:

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

-Slug

URL-friendly unique identifier (slug). Derived from -Name when omitted (whitespace replaced by '-', lowercased).

Type: String
Parameter Sets: (All)
Aliases:

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

-Manufacturer

Manufacturer assigned to this object (database ID).

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Color

Color as a 6-digit hex code (RRGGBB), e.g. 'ff0000'.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

Brief description.

Type: String
Parameter Sets: (All)
Aliases:

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

-Owner

Owner assigned to this object (database ID).

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Comments

Detailed comments (Markdown is supported).

Type: String
Parameter Sets: (All)
Aliases:

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

-Tags

One or more tags to assign to this object (tag names or IDs).

Type: Object[]
Parameter Sets: (All)
Aliases:

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

-Custom_Fields

Hashtable of custom field values to set (cf_\<name>).

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Raw

Return the raw API response instead of the results array.

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.Management.Automation.PSObject

NOTES

AddedInVersion: v4.7.0.1 Requires NetBox 4.7.0 or later.

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/rest-api/overview/