Set-NBDCIMRack
Since
v4.4.10.0
SYNOPSIS
Update a rack in Netbox
SYNTAX
Set-NBDCIMRack [-Id] <UInt64> [[-Name] <String>] [[-Site] <UInt64>] [[-Location] <UInt64>] [[-Tenant] <UInt64>]
[[-Status] <String>] [[-Role] <UInt64>] [[-Serial] <String>] [[-Asset_Tag] <String>] [[-Rack_Type] <UInt64>]
[[-Airflow] <String>] [[-Form_Factor] <String>] [[-Width] <UInt16>] [[-U_Height] <UInt16>]
[[-Starting_Unit] <UInt16>] [[-Desc_Units] <Boolean>] [[-Outer_Width] <UInt16>] [[-Outer_Depth] <UInt16>]
[[-Outer_Height] <UInt16>] [[-Mounting_Depth] <UInt16>] [[-Max_Weight] <UInt32>] [[-Weight_Unit] <String>]
[[-Facility_Id] <String>] [[-Description] <String>] [[-Comments] <String>] [[-Custom_Fields] <Hashtable>]
[[-Owner] <UInt64>] [-Force] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing rack object in Netbox.
EXAMPLES
EXAMPLE 1
Set-NBDCIMRack -Id 1 -Description "Updated description"
EXAMPLE 2
Get-NBDCIMRack -Name "Rack-01" | Set-NBDCIMRack -Status deprecated
PARAMETERS
-Id
The ID of the rack to update
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The name of the rack
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site
The site ID where the rack is located
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Location
The location ID within the site
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Tenant
The tenant ID that owns this rack
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Status
The operational status (active, planned, reserved, deprecated)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Role
The rack role ID
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Serial
The serial number
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Asset_Tag
The asset tag
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Rack_Type
The rack type ID
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Airflow
The rack airflow direction (NetBox 4.6+): 'front-to-rear' or 'rear-to-front'. Pass '' to clear the field server-side (sent as JSON null).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Form_Factor
The rack form factor (NetBox 4.6+), e.g. '2-post-frame', '4-post-cabinet'. Pass '' to clear the field server-side (sent as JSON null).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Width
The rack width (10 or 19 inches)
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-U_Height
The height in rack units
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Starting_Unit
The starting unit number
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Desc_Units
Whether units are numbered top-to-bottom
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Outer_Width
The outer width in millimeters
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Outer_Depth
The outer depth in millimeters
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Outer_Height
The outer height in millimeters
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Mounting_Depth
The mounting depth in millimeters
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Max_Weight
The maximum weight capacity
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Weight_Unit
The weight unit (kg, g, lb, oz)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Facility_Id
The facility identifier
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
A description of the rack
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Comments
Additional comments
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Custom_Fields
A hashtable of custom fields
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owner
The owner ID for object ownership (Netbox 4.5+ only).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 27
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Force
Skip confirmation prompts
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response object instead of the .results collection.
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.4.10.0