Skip to content

Get-NBAPIDefinition

Since

v1.3.3

SYNOPSIS

Retrieves Support objects from Netbox Setup module.

SYNTAX

Get-NBAPIDefinition [[-Format] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves Support objects from Netbox Setup module.

EXAMPLES

EXAMPLE 1

Get-NBAPIDefinition

PARAMETERS

-Format

Filter by format.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Json
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: v1.3.3

Common parameters

common request params
common pagination params

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