Skip to content

New-NBTenantGroup

Since

v4.4.10.0

SYNOPSIS

Creates a new tenant group in Netbox.

SYNTAX

New-NBTenantGroup [-Name] <String> [[-Slug] <String>] [[-Parent] <UInt64>] [[-Description] <String>] [[-Tags] <UInt64[]>] [[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new tenant group in the Netbox tenancy module. Tenant groups are organizational containers for grouping related tenants. Supports hierarchical nesting via the Parent parameter.

EXAMPLES

EXAMPLE 1

New-NBTenantGroup -Name "Enterprise Customers" -Slug "enterprise-customers"

Creates a new top-level tenant group.

EXAMPLE 2

New-NBTenantGroup -Name "EMEA" -Parent 1 -Description "European customers"

Creates a nested tenant group under parent ID 1.

PARAMETERS

-Name

The name of the tenant group.

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

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

-Slug

URL-friendly unique identifier. If not provided, will be auto-generated from name.

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

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

-Parent

The database ID of the parent tenant group for hierarchical organization.

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

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

-Description

A description of the tenant group.

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

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

-Tags

Array of tag IDs to assign to this tenant group.

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

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

-Custom_Fields

Hashtable of custom field values.

```yaml Type: Hashtable 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 instead of the results array.

```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.4.10.0

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/models/tenancy/tenantgroup/