Skip to content

New-NBVirtualMachineType

Since

v4.6.0.1

SYNOPSIS

Creates a new virtual machine type in Netbox Virtualization.

SYNTAX

New-NBVirtualMachineType [-Name] <String> [[-Slug] <String>] [[-Default_vCPUs] <Decimal>]
 [[-Default_Memory] <UInt64>] [[-Default_Platform] <UInt64>] [[-Description] <String>] [[-Comments] <String>]
 [[-Owner] <UInt64>] [[-Tags] <Object[]>] [[-Custom_Fields] <Hashtable>] [-Raw]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new VirtualMachineType (NetBox 4.6+). VM types categorize virtual machines by instance type (analogous to DeviceType), with optional default vCPU / memory / platform values.

EXAMPLES

EXAMPLE 1

New-NBVirtualMachineType -Name 't3.medium' -Default_vCPUs 2 -Default_Memory 4096

PARAMETERS

-Name

The name of the VM 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. Auto-generated from name if omitted.

Type: String
Parameter Sets: (All)
Aliases:

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

-Default_vCPUs

Default number of vCPUs for VMs of this type.

Type: Decimal
Parameter Sets: (All)
Aliases:

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

-Default_Memory

Default memory (MB) for VMs of this type.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Default_Platform

Default platform ID for VMs of this type.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Description

A description of the VM type.

Type: String
Parameter Sets: (All)
Aliases:

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

-Comments

Additional comments.

Type: String
Parameter Sets: (All)
Aliases:

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

-Owner

The owner ID for object ownership.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Tags

Tags to assign to this VM type.

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

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

-Custom_Fields

A hashtable of custom field values.

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.

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

Common parameters

common request params

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