Set-NBVirtualCircuit
Since
v4.4.10.0
SYNOPSIS
Updates an existing virtual circuit in Netbox.
SYNTAX
Set-NBVirtualCircuit [-Id] <UInt64> [[-Cid] <String>] [[-Provider_Network] <UInt64>]
[[-Provider_Account] <UInt64>] [[-Type] <UInt64>] [[-Status] <String>] [[-Tenant] <UInt64>]
[[-Description] <String>] [[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Tags] <Object[]>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing virtual circuit in Netbox.
EXAMPLES
EXAMPLE 1
Set-NBVirtualCircuit -Id 1 -Status "active"
PARAMETERS
-Id
The ID of the virtual circuit to update.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Cid
Circuit ID string.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Provider_Network
Provider network ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Provider_Account
Provider account ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Type
Virtual circuit type ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Status
Status (planned, provisioning, active, offline, deprovisioning, decommissioned).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tenant
Tenant ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Description
Description.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Comments.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
Custom fields hashtable.
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: Object[] Parameter Sets: (All) Aliases:
Required: False Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response.
```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