Set-NBIPAMFHRPGroup
Since
v4.4.10.0
SYNOPSIS
Updates an existing IPAM FHRPGroup in Netbox IPAM module.
SYNTAX
Set-NBIPAMFHRPGroup [-Id] <UInt64> [[-Protocol] <String>] [[-Group_Id] <UInt16>] [[-Name] <String>]
[[-Auth_Type] <String>] [[-Auth_Key] <String>] [[-Description] <String>] [[-Comments] <String>]
[[-Tags] <String[]>] [[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing IPAM FHRPGroup in Netbox IPAM module. Supports pipeline input for Id parameter where applicable.
EXAMPLES
EXAMPLE 1
Set-NBIPAMFHRPGroup
Updates an existing IPAM FHRP Group object.
PARAMETERS
-Id
{{ Fill Id Description }}
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Protocol
{{ Fill Protocol Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Group_Id
{{ Fill Group_Id Description }}
```yaml Type: UInt16 Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Name
{{ Fill Name Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Auth_Type
{{ Fill Auth_Type Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Auth_Key
{{ Fill Auth_Key Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
{{ Fill Description Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
{{ Fill Comments Description }}
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: String[] Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
{{ Fill Custom_Fields Description }}
```yaml Type: Hashtable 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 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