New-NBVPNTunnel
Since
v4.4.10.0
SYNOPSIS
Creates a new VPN Tunnel in Netbox VPN module.
SYNTAX
New-NBVPNTunnel [-Name] <String> [-Status] <String> [-Encapsulation] <String> [[-Group] <UInt64>]
[[-IPSec_Profile] <UInt64>] [[-Tenant] <UInt64>] [[-Tunnel_Id] <UInt64>] [[-Description] <String>]
[[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Tags] <Object[]>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new VPN Tunnel in Netbox VPN module.
EXAMPLES
EXAMPLE 1
New-NBVPNTunnel -Name "Site-to-Site" -Status "active" -Encapsulation "ipsec-tunnel"
Creates a new VPN Tunnel object.
PARAMETERS
-Name
The name of the VPN tunnel (required).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Status
Tunnel status: 'active', 'planned', or 'disabled' (required).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Encapsulation
Tunnel encapsulation type: 'ipsec-transport', 'ipsec-tunnel', 'ip-ip', or 'gre' (required).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Group
Tunnel group ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-IPSec_Profile
IPSec profile ID to associate with this tunnel.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Tenant
Tenant ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Tunnel_Id
Numeric tunnel identifier.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Description
Description of the tunnel.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Additional 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
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 ```
-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 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