Skip to content

Set-NBSavedFilter

Since

v4.4.10.0

SYNOPSIS

Updates an existing saved filter in Netbox.

SYNTAX

Set-NBSavedFilter [-Id] <UInt64> [[-Name] <String>] [[-Slug] <String>] [[-Object_Types] <String[]>] [[-Description] <String>] [[-Weight] <UInt16>] [[-Enabled] <Boolean>] [[-Shared] <Boolean>] [[-Parameters] <Hashtable>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing saved filter in Netbox Extras module.

EXAMPLES

EXAMPLE 1

Set-NBSavedFilter -Id 1 -Enabled $false

PARAMETERS

-Id

The ID of the saved filter to update.

```yaml 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 saved filter.

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

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

-Slug

URL-friendly slug.

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

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

-Object_Types

Object types this filter applies to.

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

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

-Description

Description of the filter.

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

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

-Weight

Display weight.

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

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

-Enabled

Whether the filter is enabled.

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

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

-Shared

Whether the filter is shared.

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

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

-Parameters

Filter parameters (hashtable).

```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/