Get-NBCircuitTermination
Since
v1.3.3
SYNOPSIS
Retrieves Terminations objects from Netbox Circuits module.
SYNTAX
Query (Default)
Get-NBCircuitTermination [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Circuit_ID <String>] [-Term_Side <String>] [-Port_Speed <UInt64>] [-Query <String>] [-Site_ID <String>]
[-Site <String>] [-XConnect_ID <String>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ById
Get-NBCircuitTermination [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Id <UInt64[]>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves Terminations objects from Netbox Circuits module.
EXAMPLES
EXAMPLE 1
Get-NBCircuitTermination
PARAMETERS
-All
Automatically fetch all pages of results. Uses the API's pagination to retrieve all items across multiple requests.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of items per page when using -All. Default: 100. Range: 1-1000.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
-Brief
Return a minimal representation of objects (id, url, display, name only). Reduces response size by ~90%. Ideal for dropdowns and reference lists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Fields
Specify which fields to include in the response. Supports nested field selection (e.g., 'site.name', 'device_type.model').
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Omit
Specify which fields to exclude from the response. Requires Netbox 4.5.0 or later.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
One or more database IDs to retrieve.
Type: UInt64[]
Parameter Sets: ById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Circuit_ID
Filter by circuit database ID.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Term_Side
Filter by term side.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Port_Speed
Physical circuit speed
Type: UInt64
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Query
Free-text search across the object (NetBox 'q' parameter).
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site_ID
Filter by site database ID.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site
Filter by site (name or slug).
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-XConnect_ID
Filter by xconnect database ID.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Limit
Maximum number of results to return per request (1-1000).
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Offset
Number of results to skip (pagination offset).
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
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
-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 The -Brief, -Fields, and -Omit parameters are mutually exclusive.