Skip to content

New-NBVPNIKEProposal

Since

v4.4.10.0

SYNOPSIS

Creates a new IKE Proposal in Netbox VPN module.

SYNTAX

New-NBVPNIKEProposal [-Name] <String> [-Authentication_Method] <String> [-Encryption_Algorithm] <String> [[-Authentication_Algorithm] <String>] [-Group] <UInt16> [[-SA_Lifetime] <UInt32>] [[-Description] <String>] [[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new IKE (Internet Key Exchange) Proposal for VPN configuration.

EXAMPLES

EXAMPLE 1

New-NBVPNIKEProposal -Name "IKE-Proposal-1" -Authentication_Method "preshared-keys" -Encryption_Algorithm "aes-256-cbc" -Authentication_Algorithm "hmac-sha256" -Group 14

PARAMETERS

-Name

The name of the IKE proposal (required)

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

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

-Authentication_Method

Authentication method: 'preshared-keys' or 'certificates' (required)

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

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

-Encryption_Algorithm

Encryption algorithm (required). Options: 'aes-128-cbc', 'aes-192-cbc', 'aes-256-cbc', etc.

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

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

-Authentication_Algorithm

Authentication/integrity algorithm (e.g., 'hmac-sha1', 'hmac-sha256', 'hmac-sha384', 'hmac-sha512', 'hmac-md5')

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

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

-Group

Diffie-Hellman group number (required). Options: 1, 2, 5, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24

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

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

-SA_Lifetime

Security Association lifetime in seconds

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

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

-Description

Description of the proposal

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

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

-Comments

Additional comments

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

Required: False Position: 8 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: 9 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: 10 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/