Skip to content

Set-NBQueryOption

SYNOPSIS

Sets the behaviour of query parameters.

SYNTAX

Set-NBQueryOption [-IgnoreCase] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets the behaviour of query parameters (see notes).

EXAMPLES

EXAMPLE 1

Set-NBQueryOption -IgnoreCase
Sets the Netbox API query parameters to be case-insensitive.

EXAMPLE 2

Set-NBQueryOption -IgnoreCase:$false
Sets the Netbox API query parameters to be case-sensitive (default on startup of the module).

PARAMETERS

-IgnoreCase

If set, query parameters of type string will be case-insensitive (Netbox's `__ie`)

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.Boolean

NOTES

Depending on the API version, different sets of parameters are supported as case-insensitive. As this feature is relying on the API version and its supported parameters, not all parameters are supported as case-insensitive.

Common parameters

common request params

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