Skip to content

Set-NBVPNIKEProposal

Since

v4.4.10.0

SYNOPSIS

Updates an existing VPN IKEProposal in Netbox VPN module.

SYNTAX

Set-NBVPNIKEProposal [-Id] <UInt64> [[-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

Updates an existing VPN IKEProposal in Netbox VPN module. Supports pipeline input for Id parameter where applicable.

EXAMPLES

EXAMPLE 1

Set-NBVPNIKEProposal

Updates an existing VPN IKEProposal object.

PARAMETERS

-Id

Database ID of the object to update.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-Name

Name of the object.

Type: String
Parameter Sets: (All)
Aliases:

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

-Authentication_Method

Authentication Method.

Type: String
Parameter Sets: (All)
Aliases:

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

-Encryption_Algorithm

Encryption Algorithm.

Type: String
Parameter Sets: (All)
Aliases:

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

-Authentication_Algorithm

Authentication Algorithm.

Type: String
Parameter Sets: (All)
Aliases:

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

-Group

Group assigned to this object (database ID).

Type: UInt16
Parameter Sets: (All)
Aliases:

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

-SA_Lifetime

Security association lifetime (in seconds)

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-Description

Brief description.

Type: String
Parameter Sets: (All)
Aliases:

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

-Comments

Detailed comments (Markdown is supported).

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 to set (cf_\<name>).

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Tags

One or more tags to assign to this object (tag names or IDs).

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.

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.

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.

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 }}

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/