Skip to content

Set-NBVirtualMachineInterface

Since

v1.0.4

SYNOPSIS

Updates an existing irtualMachineInterface in Netbox V module.

SYNTAX

Set-NBVirtualMachineInterface [-Id] <UInt64> [[-Name] <String>] [[-MAC_Address] <String>] [[-MTU] <UInt16>] [[-Description] <String>] [[-Enabled] <Boolean>] [[-Virtual_Machine] <UInt64>] [-Force] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing irtualMachineInterface in Netbox V module. Supports pipeline input for Id parameter where applicable.

EXAMPLES

EXAMPLE 1

Set-NBVirtualMachineInterface

Updates an existing Virtual Machine Interface object.

PARAMETERS

-Id

{{ Fill Id Description }}

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

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

-Name

{{ Fill Name Description }}

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

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

-MAC_Address

{{ Fill MAC_Address Description }}

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

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

-MTU

{{ Fill MTU Description }}

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

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

-Description

{{ Fill Description Description }}

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

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

-Enabled

{{ Fill Enabled Description }}

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

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

-Virtual_Machine

{{ Fill Virtual_Machine Description }}

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

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

-Force

{{ Fill Force Description }}

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

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

-Tags

{{ Fill Tags Description }}

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

Required: False Position: 8 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: v1.0.4

Common parameters

common request params

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