Get-NBBranch
Since
v1.3.3
SYNOPSIS
Retrieves Branch objects from the Netbox Branching plugin.
SYNTAX
Query (Default)
Get-NBBranch [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Name <String>]
[-Status <String>] [-Owner <String>] [-Query <String>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ById
Get-NBBranch [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Id <UInt64[]>]
[-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves one or more branches from the Netbox Branching plugin. Supports filtering by ID, name, status, and owner.
EXAMPLES
EXAMPLE 1
Get-NBBranch
Get all branches.
EXAMPLE 2
Get-NBBranch -Id 5
Get branch with ID 5.
EXAMPLE 3
Get-NBBranch -Name "feature/datacenter"
Get branch by name.
EXAMPLE 4
Get-NBBranch -Status "ready"
Get all ready branches.
PARAMETERS
-All
Retrieve all branches with automatic pagination.
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.
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
The ID of a specific branch to retrieve.
Type: UInt64[]
Parameter Sets: ById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
Filter branches by name.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status
Filter branches by status. Valid values (from netbox-branching BranchStatusChoices): Transitional: provisioning, syncing, migrating, merging, reverting Terminal "working": new, ready, pending-migrations Terminal "done": merged, archived Terminal "failure": failed
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owner
Filter branches by owner username.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Query
Search query string.
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.
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.
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.
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
[PSCustomObject] Branch object(s).
NOTES
AddedInVersion: v1.3.3 The -Brief, -Fields, and -Omit parameters are mutually exclusive.