Skip to content

New-NBExportTemplate

Since

v4.4.10.0

SYNOPSIS

Creates a new export template in Netbox.

SYNTAX

New-NBExportTemplate [-Name] <String> [-Object_Types] <String[]> [[-Description] <String>] [[-Template_Code] <String>] [[-Mime_Type] <String>] [[-File_Extension] <String>] [[-As_Attachment] <Boolean>] [[-Data_Source] <UInt64>] [[-Data_File] <UInt64>] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new export template in Netbox Extras module.

EXAMPLES

EXAMPLE 1

New-NBExportTemplate -Name "CSV Export" -Object_Types @("dcim.device") -Template_Code "{% for d in queryset %}{{ d.name }}{% endfor %}"

PARAMETERS

-Name

Name of the export template.

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

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

-Object_Types

Object types this template applies to.

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

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

-Description

Description of the template.

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

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

-Template_Code

Jinja2 template code.

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

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

-Mime_Type

MIME type for the export.

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

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

-File_Extension

File extension for the export.

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

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

-As_Attachment

Whether to serve as attachment.

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

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

-Data_Source

Data source ID.

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

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

-Data_File

Data file ID.

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

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

-Tags

{{ Fill Tags Description }}

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

Required: False Position: 10 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.4.10.0

Common parameters

common request params

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