Set-NBVirtualizationClusterType

Since

v4.4.10.0

SYNOPSIS

Updates an existing virtualization cluster type in Netbox.

SYNTAX

Set-NBVirtualizationClusterType [-Id] <UInt64> [[-Name] <String>] [[-Slug] <String>] [[-Description] <String>]
 [[-Tags] <UInt64[]>] [[-Custom_Fields] <Hashtable>] [-Force] [-Raw] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing cluster type in the Netbox virtualization module. Supports pipeline input from Get-NBVirtualizationClusterType.

EXAMPLES

EXAMPLE 1

Set-NBVirtualizationClusterType -Id 1 -Description "VMware vSphere 8.0"

Updates the description of cluster type ID 1.

EXAMPLE 2

Get-NBVirtualizationClusterType -Slug "kvm" | Set-NBVirtualizationClusterType -Name "KVM/QEMU"

Updates a cluster type found by slug via pipeline.

PARAMETERS

-Id

The database ID of the cluster type to update. Accepts pipeline input.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Name

The new name of the cluster type.

Type: String
Parameter Sets: (All)
Aliases:

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

-Slug

URL-friendly unique identifier.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

A description of the cluster type.

Type: String
Parameter Sets: (All)
Aliases:

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

-Tags

Array of tag IDs to assign.

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

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

-Custom_Fields

Hashtable of custom field values.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
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

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

Common parameters

common request params

RELATED LINKS

https://netbox.readthedocs.io/en/stable/models/virtualization/clustertype/