published on Monday, Nov 16, 2026 by e-breuninger
published on Monday, Nov 16, 2026 by e-breuninger
A NetBox module type profile (dcim.moduletypeprofile): a JSON schema for the attributes of the module types that use it.
From the official documentation:
Each module type may optionally be assigned a profile according to its classification. A profile can extend module types with user-configured attributes — for example, the input current and voltage of a power supply, or the clock speed and number of cores for a processor.
Module type attributes are managed by configuring a JSON schema on the profile.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
const test = new netbox.ModuleTypeProfile("test", {
name: "test-module-type-profile",
description: "test-description",
schema: JSON.stringify({
properties: {
capacity: {
type: "integer",
},
},
}),
});
import pulumi
import json
import pulumi_netbox as netbox
test = netbox.ModuleTypeProfile("test",
name="test-module-type-profile",
description="test-description",
schema=json.dumps({
"properties": {
"capacity": {
"type": "integer",
},
},
}))
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"properties": map[string]interface{}{
"capacity": map[string]interface{}{
"type": "integer",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = netbox.NewModuleTypeProfile(ctx, "test", &netbox.ModuleTypeProfileArgs{
Name: pulumi.String("test-module-type-profile"),
Description: pulumi.String("test-description"),
Schema: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
var test = new Netbox.ModuleTypeProfile("test", new()
{
Name = "test-module-type-profile",
Description = "test-description",
Schema = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["properties"] = new Dictionary<string, object?>
{
["capacity"] = new Dictionary<string, object?>
{
["type"] = "integer",
},
},
}),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.ModuleTypeProfile;
import com.pulumi.netbox.ModuleTypeProfileArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new ModuleTypeProfile("test", ModuleTypeProfileArgs.builder()
.name("test-module-type-profile")
.description("test-description")
.schema(serializeJson(
jsonObject(
jsonProperty("properties", jsonObject(
jsonProperty("capacity", jsonObject(
jsonProperty("type", "integer")
))
))
)))
.build());
}
}
resources:
test:
type: netbox:ModuleTypeProfile
properties:
name: test-module-type-profile
description: test-description
schema:
fn::toJSON:
properties:
capacity:
type: integer
Example coming soon!
Create ModuleTypeProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ModuleTypeProfile(name: string, args?: ModuleTypeProfileArgs, opts?: CustomResourceOptions);@overload
def ModuleTypeProfile(resource_name: str,
args: Optional[ModuleTypeProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ModuleTypeProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
comments: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
owner_id: Optional[float] = None,
schema: Optional[str] = None,
tags: Optional[Sequence[str]] = None)func NewModuleTypeProfile(ctx *Context, name string, args *ModuleTypeProfileArgs, opts ...ResourceOption) (*ModuleTypeProfile, error)public ModuleTypeProfile(string name, ModuleTypeProfileArgs? args = null, CustomResourceOptions? opts = null)
public ModuleTypeProfile(String name, ModuleTypeProfileArgs args)
public ModuleTypeProfile(String name, ModuleTypeProfileArgs args, CustomResourceOptions options)
type: netbox:ModuleTypeProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "netbox_module_type_profile" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ModuleTypeProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ModuleTypeProfileArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ModuleTypeProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ModuleTypeProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ModuleTypeProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var moduleTypeProfileResource = new Netbox.ModuleTypeProfile("moduleTypeProfileResource", new()
{
Comments = "string",
CustomFields =
{
{ "string", "string" },
},
Description = "string",
Name = "string",
OwnerId = 0.0,
Schema = "string",
Tags = new[]
{
"string",
},
});
example, err := netbox.NewModuleTypeProfile(ctx, "moduleTypeProfileResource", &netbox.ModuleTypeProfileArgs{
Comments: pulumi.String("string"),
CustomFields: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
OwnerId: pulumi.Float64(0),
Schema: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "netbox_module_type_profile" "moduleTypeProfileResource" {
lifecycle {
create_before_destroy = true
}
comments = "string"
custom_fields = {
"string" = "string"
}
description = "string"
name = "string"
owner_id = 0
schema = "string"
tags = ["string"]
}
var moduleTypeProfileResource = new ModuleTypeProfile("moduleTypeProfileResource", ModuleTypeProfileArgs.builder()
.comments("string")
.customFields(Map.of("string", "string"))
.description("string")
.name("string")
.ownerId(0.0)
.schema("string")
.tags("string")
.build());
module_type_profile_resource = netbox.ModuleTypeProfile("moduleTypeProfileResource",
comments="string",
custom_fields={
"string": "string",
},
description="string",
name="string",
owner_id=float(0),
schema="string",
tags=["string"])
const moduleTypeProfileResource = new netbox.ModuleTypeProfile("moduleTypeProfileResource", {
comments: "string",
customFields: {
string: "string",
},
description: "string",
name: "string",
ownerId: 0,
schema: "string",
tags: ["string"],
});
type: netbox:ModuleTypeProfile
properties:
comments: string
customFields:
string: string
description: string
name: string
ownerId: 0
schema: string
tags:
- string
ModuleTypeProfile Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ModuleTypeProfile resource accepts the following input properties:
- Comments string
- Custom
Fields Dictionary<string, string> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Name string
- Owner
Id double - Id of the owner the object is assigned to.
- Schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<string>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Comments string
- Custom
Fields map[string]string - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Name string
- Owner
Id float64 - Id of the owner the object is assigned to.
- Schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- []string
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- comments string
- custom_
fields map(string) - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- name string
- owner_
id number - Id of the owner the object is assigned to.
- schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- list(string)
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- comments String
- custom
Fields Map<String,String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- name String
- owner
Id Double - Id of the owner the object is assigned to.
- schema String
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- comments string
- custom
Fields {[key: string]: string} - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- name string
- owner
Id number - Id of the owner the object is assigned to.
- schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- string[]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- comments str
- custom_
fields Mapping[str, str] - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description str
- name str
- owner_
id float - Id of the owner the object is assigned to.
- schema str
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- Sequence[str]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- comments String
- custom
Fields Map<String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- name String
- owner
Id Number - Id of the owner the object is assigned to.
- schema String
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
Outputs
All input properties are implicitly available as output properties. Additionally, the ModuleTypeProfile resource produces the following output properties:
- Created string
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - Module
Type doubleProfile Id - NetBox id.
- List<string>
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Created string
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - Module
Type float64Profile Id - NetBox id.
- []string
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- created string
- id string
- The provider-assigned unique ID for this managed resource.
- last_
updated string - module_
type_ numberprofile_ id - NetBox id.
- list(string)
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- created String
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - module
Type DoubleProfile Id - NetBox id.
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- created string
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated string - module
Type numberProfile Id - NetBox id.
- string[]
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- created str
- id str
- The provider-assigned unique ID for this managed resource.
- last_
updated str - module_
type_ floatprofile_ id - NetBox id.
- Sequence[str]
- Slugs of all tags on the object, including the provider's default_tags.
- url str
- created String
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - module
Type NumberProfile Id - NetBox id.
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
Look up Existing ModuleTypeProfile Resource
Get an existing ModuleTypeProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ModuleTypeProfileState, opts?: CustomResourceOptions): ModuleTypeProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comments: Optional[str] = None,
created: Optional[str] = None,
custom_fields: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
last_updated: Optional[str] = None,
module_type_profile_id: Optional[float] = None,
name: Optional[str] = None,
owner_id: Optional[float] = None,
schema: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
tags_alls: Optional[Sequence[str]] = None,
url: Optional[str] = None) -> ModuleTypeProfilefunc GetModuleTypeProfile(ctx *Context, name string, id IDInput, state *ModuleTypeProfileState, opts ...ResourceOption) (*ModuleTypeProfile, error)public static ModuleTypeProfile Get(string name, Input<string> id, ModuleTypeProfileState? state, CustomResourceOptions? opts = null)public static ModuleTypeProfile get(String name, Output<String> id, ModuleTypeProfileState state, CustomResourceOptions options)resources: existingModuleTypeProfile: type: netbox:ModuleTypeProfile get: id: ${id}import {
to = netbox_module_type_profile.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state ModuleTypeProfileState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ModuleTypeProfileState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state ModuleTypeProfileState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state ModuleTypeProfileState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Comments string
- Created string
- Custom
Fields Dictionary<string, string> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Last
Updated string - Module
Type doubleProfile Id - NetBox id.
- Name string
- Owner
Id double - Id of the owner the object is assigned to.
- Schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<string>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<string>
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- Comments string
- Created string
- Custom
Fields map[string]string - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- Description string
- Last
Updated string - Module
Type float64Profile Id - NetBox id.
- Name string
- Owner
Id float64 - Id of the owner the object is assigned to.
- Schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- []string
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- []string
- Slugs of all tags on the object, including the provider's default_tags.
- Url string
- comments string
- created string
- custom_
fields map(string) - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- last_
updated string - module_
type_ numberprofile_ id - NetBox id.
- name string
- owner_
id number - Id of the owner the object is assigned to.
- schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- list(string)
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- list(string)
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- comments String
- created String
- custom
Fields Map<String,String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- last
Updated String - module
Type DoubleProfile Id - NetBox id.
- name String
- owner
Id Double - Id of the owner the object is assigned to.
- schema String
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
- comments string
- created string
- custom
Fields {[key: string]: string} - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description string
- last
Updated string - module
Type numberProfile Id - NetBox id.
- name string
- owner
Id number - Id of the owner the object is assigned to.
- schema string
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- string[]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- string[]
- Slugs of all tags on the object, including the provider's default_tags.
- url string
- comments str
- created str
- custom_
fields Mapping[str, str] - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description str
- last_
updated str - module_
type_ floatprofile_ id - NetBox id.
- name str
- owner_
id float - Id of the owner the object is assigned to.
- schema str
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- Sequence[str]
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- Sequence[str]
- Slugs of all tags on the object, including the provider's default_tags.
- url str
- comments String
- created String
- custom
Fields Map<String> - Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
- description String
- last
Updated String - module
Type NumberProfile Id - NetBox id.
- name String
- owner
Id Number - Id of the owner the object is assigned to.
- schema String
- JSON schema describing the attributes of module types with this profile (use jsonencode()).
- List<String>
- Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
- List<String>
- Slugs of all tags on the object, including the provider's default_tags.
- url String
Import
In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:
terraform
import {
to = netbox_module_type_profile.test
id = “123”
}
The pulumi import command can be used, for example:
$ pulumi import netbox:index/moduleTypeProfile:ModuleTypeProfile test 123
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
published on Monday, Nov 16, 2026 by e-breuninger