Skip to content

New-NBOwner

Since

v4.5.0.0

SYNOPSIS

Creates a new owner in Netbox (Netbox 4.5+).

SYNTAX

New-NBOwner [-Name] <String> [[-Group] <UInt64>] [[-Description] <String>] [[-User_Groups] <UInt64[]>] [[-Users] <UInt64[]>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new owner in Netbox Users module. Owners represent sets of users and/or groups for tracking native object ownership. This endpoint is only available in Netbox 4.5 and later.

EXAMPLES

EXAMPLE 1

New-NBOwner -Name "Network Operations"

EXAMPLE 2

New-NBOwner -Name "Data Center Team" -Description "Responsible for DC infrastructure" -Users 1, 2, 3

EXAMPLE 3

New-NBOwner -Name "Cloud Team" -Group 1 -User_Groups 5, 6

PARAMETERS

-Name

The name of the owner (required, must be unique).

```yaml Type: String Parameter Sets: (All) Aliases:

Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Group

The owner group ID to associate this owner with.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-Description

A description of the owner.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-User_Groups

Array of group IDs to associate with this owner.

```yaml Type: UInt64[] Parameter Sets: (All) Aliases:

Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Users

Array of user IDs to associate with this owner.

```yaml Type: UInt64[] Parameter Sets: (All) Aliases:

Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Tags

{{ Fill Tags Description }}

```yaml Type: Object[] Parameter Sets: (All) Aliases:

Required: False Position: 6 Default value: None 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 ```

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi

Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Confirm

Prompts you for confirmation before running the cmdlet.

```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf

Required: False Position: Named Default value: None 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: v4.5.0.0

Common parameters

common request params

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