Get-NBOwnerGroup
Since
v1.3.3
SYNOPSIS
Retrieves owner groups from Netbox (Netbox 4.5+).
SYNTAX
Query (Default)
Get-NBOwnerGroup [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Name <String>]
[-Query <String>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
ById
Get-NBOwnerGroup [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Id <UInt64[]>]
[-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves owner groups from Netbox Users module. Owner groups are used to organize owners for object ownership tracking. This endpoint is only available in Netbox 4.5 and later.
EXAMPLES
EXAMPLE 1
Get-NBOwnerGroup
EXAMPLE 2
Get-NBOwnerGroup -Name "Network Team"
EXAMPLE 3
Get-NBOwnerGroup -Id 5
PARAMETERS
-All
Retrieve all owner groups (pagination handled automatically).
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-PageSize
Number of results per page (1-1000, default 100).
```yaml 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.
```yaml 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').
```yaml 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.
```yaml Type: String[] Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Id
Database ID of the owner group.
```yaml Type: UInt64[] Parameter Sets: ById Aliases:
Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Name
Filter by name.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Query
Search query.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Limit
Number of results to return.
```yaml Type: UInt16 Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Offset
Result offset for pagination.
```yaml 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.
```yaml 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 }}
```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: v1.3.3 The -Brief, -Fields, and -Omit parameters are mutually exclusive.