Get-NBUser
Since
v1.3.3
SYNOPSIS
Retrieves users from Netbox.
SYNTAX
Query (Default)
Get-NBUser [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Username <String>]
[-First_Name <String>] [-Last_Name <String>] [-Email <String>] [-Is_Staff <Boolean>] [-Is_Active <Boolean>]
[-Is_Superuser <Boolean>] [-Group_Id <UInt64>] [-Query <String>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ById
Get-NBUser [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Id <UInt64[]>]
[-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves users from Netbox Users module.
EXAMPLES
EXAMPLE 1
Get-NBUser
EXAMPLE 2
Get-NBUser -Username "admin"
PARAMETERS
-All
Automatically fetch all pages of results. Uses the API's pagination to retrieve all items across multiple requests.
```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 items per page when using -All. Default: 100. Range: 1-1000.
```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 user.
```yaml Type: UInt64[] Parameter Sets: ById Aliases:
Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Username
Filter by username.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-First_Name
Filter by first name.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Last_Name
Filter by last name.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
Filter by email.
```yaml Type: String Parameter Sets: Query Aliases:
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Is_Staff
Filter by staff status.
```yaml Type: Boolean Parameter Sets: Query Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Is_Active
Filter by active status.
```yaml Type: Boolean Parameter Sets: Query Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Is_Superuser
Filter by superuser status.
```yaml Type: Boolean Parameter Sets: Query Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Group_Id
Filter by group ID.
```yaml Type: UInt64 Parameter Sets: Query Aliases:
Required: False Position: Named Default value: 0 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.