Skip to content

New-NBVPNIPSecProfile

Since

v4.4.10.0

SYNOPSIS

Creates a new IPSec Profile in Netbox VPN module.

SYNTAX

New-NBVPNIPSecProfile [-Name] <String> [-Mode] <String> [-IKE_Policy] <UInt64> [-IPSec_Policy] <UInt64> [[-Description] <String>] [[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new IPSec Profile that combines IKE and IPSec policies for VPN configuration.

EXAMPLES

EXAMPLE 1

New-NBVPNIPSecProfile -Name "IPSec-Profile-1" -Mode "esp" -IKE_Policy 1 -IPSec_Policy 1

PARAMETERS

-Name

The name of the IPSec profile (required)

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

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

-Mode

IPSec mode: 'esp' (Encapsulating Security Payload) or 'ah' (Authentication Header) (required)

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

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

-IKE_Policy

The IKE policy ID to associate with this profile (required)

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

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

-IPSec_Policy

The IPSec policy ID to associate with this profile (required)

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

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

-Description

Description of the profile

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

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

-Comments

Additional comments

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

Required: False Position: 6 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: 7 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: 8 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

Common parameters

common request params

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