Skip to content

New-NBVirtualizationCluster

Since

v4.4.10.0

SYNOPSIS

Creates a new virtualization cluster in Netbox.

SYNTAX

New-NBVirtualizationCluster [-Name] <String> [-Type] <UInt64> [[-Group] <UInt64>] [[-Site] <UInt64>] [[-Status] <String>] [[-Tenant] <UInt64>] [[-Description] <String>] [[-Comments] <String>] [[-Tags] <UInt64[]>] [[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new virtualization cluster in the Netbox virtualization module. Clusters represent a pool of resources (hypervisors) that host virtual machines.

EXAMPLES

EXAMPLE 1

New-NBVirtualizationCluster -Name "Production vSphere" -Type 1

Creates a new cluster with the specified name and type.

EXAMPLE 2

$type = Get-NBVirtualizationClusterType -Name "VMware vSphere" New-NBVirtualizationCluster -Name "DC1-Cluster" -Type $type.Id -Site 1 -Status "active"

Creates a new active cluster associated with a site.

PARAMETERS

-Name

The name of the cluster.

```yaml Type: String Parameter Sets: (All) Aliases:

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

-Type

The database ID of the cluster type (e.g., VMware vSphere, KVM, Hyper-V).

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: True Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-Group

The database ID of the cluster group this cluster belongs to.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

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

-Site

The database ID of the site where this cluster is located.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

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

-Status

The operational status of the cluster: planned, staging, active, decommissioning, offline.

```yaml Type: String Parameter Sets: (All) Aliases:

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

-Tenant

The database ID of the tenant that owns this cluster.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

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

-Description

A description of the cluster.

```yaml Type: String Parameter Sets: (All) Aliases:

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

-Comments

Additional comments about the cluster.

```yaml Type: String Parameter Sets: (All) Aliases:

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

-Tags

Array of tag IDs to assign to this cluster.

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

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

-Custom_Fields

Hashtable of custom field values.

```yaml Type: Hashtable Parameter Sets: (All) Aliases:

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

-Raw

Return the raw API response instead of the results array.

```yaml 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.

```yaml 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.

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

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

NOTES

AddedInVersion: v4.4.10.0

Common parameters

common request params

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