package
0.0.3
Repository: https://github.com/hbjydev/pulumi-netbox.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

GetAggregate gets an existing Aggregate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetAvailableIpAddress gets an existing AvailableIpAddress resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetAvailablePrefix gets an existing AvailablePrefix resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCircuit gets an existing Circuit resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCircuitProvider gets an existing CircuitProvider resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCircuitTermination gets an existing CircuitTermination resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCircuitType gets an existing CircuitType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetClusterGroup gets an existing ClusterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetClusterType gets an existing ClusterType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetCustomField gets an existing CustomField resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetDevice gets an existing Device resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetDeviceRole gets an existing DeviceRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetDeviceType gets an existing DeviceType resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetInterface gets an existing Interface resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
No description provided by the author
No description provided by the author
GetIpAddress gets an existing IpAddress resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
No description provided by the author
No description provided by the author
GetIpamRole gets an existing IpamRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetIpRange gets an existing IpRange resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetManufacturer gets an existing Manufacturer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetPlatform gets an existing Platform resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetPrefix gets an existing Prefix resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetPrimaryIp gets an existing PrimaryIp resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetRegion gets an existing Region resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetRir gets an existing Rir resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetService gets an existing Service resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetSite gets an existing Site resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetTag gets an existing Tag resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetTenant gets an existing Tenant resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetTenantGroup gets an existing TenantGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
No description provided by the author
No description provided by the author
GetToken gets an existing Token resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetVirtualMachine gets an existing VirtualMachine resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { vmwCluster01, err := netbox.LookupCluster(ctx, &GetClusterArgs{ Name: "vmw-cluster-01", }, nil) if err != nil { return err } _, err = netbox.GetVirtualMachines(ctx, &GetVirtualMachinesArgs{ NameRegex: pulumi.StringRef("myvm-1"), Filters: []GetVirtualMachinesFilter{ GetVirtualMachinesFilter{ Name: "cluster_id", Value: vmwCluster01.Id, }, }, }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
GetVlan gets an existing Vlan resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
GetVrf gets an existing Vrf resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupCluster(ctx, &GetClusterArgs{ Name: "vmw-cluster-01", }, nil) if err != nil { return err } return nil }) } ```.
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupClusterGroup(ctx, &GetClusterGroupArgs{ Name: "dc-west", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupDeviceRole(ctx, &GetDeviceRoleArgs{ Name: "core-sw", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupDeviceType(ctx, &GetDeviceTypeArgs{ Model: pulumi.StringRef("7210 SAS-Sx 10/100GE"), }, nil) if err != nil { return err } _, err = netbox.LookupDeviceType(ctx, &GetDeviceTypeArgs{ Slug: pulumi.StringRef("7210-sas-sx-10-100GE"), }, nil) if err != nil { return err } _, err = netbox.LookupDeviceType(ctx, &GetDeviceTypeArgs{ Manufacturer: pulumi.StringRef("Nokia"), PartNumber: pulumi.StringRef("3HE11597AARB01"), }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupIpRange(ctx, &GetIpRangeArgs{ Contains: "10.0.0.1/24", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupPlatform(ctx, &GetPlatformArgs{ Name: "PANOS", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupSite(ctx, &GetSiteArgs{ Name: pulumi.StringRef("Example Site 1"), }, nil) if err != nil { return err } _, err = netbox.LookupSite(ctx, &GetSiteArgs{ Slug: pulumi.StringRef("example-site-1"), }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupTag(ctx, &GetTagArgs{ Name: "DMZ", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupTenant(ctx, &GetTenantArgs{ Name: "Customer A", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupVlan(ctx, &GetVlanArgs{ Name: pulumi.StringRef("vlan-1"), }, nil) if err != nil { return err } _, err = netbox.LookupVlan(ctx, &GetVlanArgs{ Vid: pulumi.IntRef(1234), }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.LookupVrf(ctx, &GetVrfArgs{ Name: "cust-a-prod", }, nil) if err != nil { return err } return nil }) } ```.
No description provided by the author
NewAggregate registers a new resource with the given unique name, arguments, and options.
NewAvailableIpAddress registers a new resource with the given unique name, arguments, and options.
NewAvailablePrefix registers a new resource with the given unique name, arguments, and options.
NewCircuit registers a new resource with the given unique name, arguments, and options.
NewCircuitProvider registers a new resource with the given unique name, arguments, and options.
NewCircuitTermination registers a new resource with the given unique name, arguments, and options.
NewCircuitType registers a new resource with the given unique name, arguments, and options.
NewCluster registers a new resource with the given unique name, arguments, and options.
NewClusterGroup registers a new resource with the given unique name, arguments, and options.
NewClusterType registers a new resource with the given unique name, arguments, and options.
NewCustomField registers a new resource with the given unique name, arguments, and options.
NewDevice registers a new resource with the given unique name, arguments, and options.
NewDeviceRole registers a new resource with the given unique name, arguments, and options.
NewDeviceType registers a new resource with the given unique name, arguments, and options.
NewInterface registers a new resource with the given unique name, arguments, and options.
NewIpAddress registers a new resource with the given unique name, arguments, and options.
NewIpamRole registers a new resource with the given unique name, arguments, and options.
NewIpRange registers a new resource with the given unique name, arguments, and options.
NewManufacturer registers a new resource with the given unique name, arguments, and options.
NewPlatform registers a new resource with the given unique name, arguments, and options.
NewPrefix registers a new resource with the given unique name, arguments, and options.
NewPrimaryIp registers a new resource with the given unique name, arguments, and options.
NewProvider registers a new resource with the given unique name, arguments, and options.
NewRegion registers a new resource with the given unique name, arguments, and options.
NewRir registers a new resource with the given unique name, arguments, and options.
NewService registers a new resource with the given unique name, arguments, and options.
NewSite registers a new resource with the given unique name, arguments, and options.
NewTag registers a new resource with the given unique name, arguments, and options.
NewTenant registers a new resource with the given unique name, arguments, and options.
NewTenantGroup registers a new resource with the given unique name, arguments, and options.
NewToken registers a new resource with the given unique name, arguments, and options.
NewUser registers a new resource with the given unique name, arguments, and options.
NewVirtualMachine registers a new resource with the given unique name, arguments, and options.
NewVlan registers a new resource with the given unique name, arguments, and options.
NewVrf registers a new resource with the given unique name, arguments, and options.
PkgVersion uses reflection to determine the version of the current package.

# Structs

From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/ipam/#aggregates): > NetBox allows us to specify the portions of IP space that are interesting to us by defining aggregates.
The set of arguments for constructing a Aggregate resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a AvailableIpAddress resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { testPrefix, err := netbox.LookupPrefix(ctx, &GetPrefixArgs{ Cidr: "10.0.0.0/24", }, nil) if err != nil { return err } _, err = netbox.NewAvailablePrefix(ctx, "testAvailablePrefix", &netbox.AvailablePrefixArgs{ ParentPrefixId: pulumi.Int(testPrefix.Id), PrefixLength: pulumi.Int(25), Status: pulumi.String("active"), }) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a AvailablePrefix resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/circuits/#circuits_1): > A communications circuit represents a single physical link connecting exactly two endpoints, commonly referred to as its A and Z terminations.
The set of arguments for constructing a Circuit resource.
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/circuits/#providers): > A circuit provider is any entity which provides some form of connectivity of among sites or organizations within a site.
The set of arguments for constructing a CircuitProvider resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/circuits/#circuit-terminations): > The association of a circuit with a particular site and/or device is modeled separately as a circuit termination.
The set of arguments for constructing a CircuitTermination resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/circuits/#circuit-types): > Circuits are classified by functional type.
The set of arguments for constructing a CircuitType resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/virtualization/#clusters): > A cluster is a logical grouping of physical resources within which virtual machines run.
The set of arguments for constructing a Cluster resource.
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/virtualization/#cluster-groups): > Cluster groups may be created for the purpose of organizing clusters.
The set of arguments for constructing a ClusterGroup resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/virtualization/#cluster-types): > A cluster type represents a technology or mechanism by which a cluster is formed.
The set of arguments for constructing a ClusterType resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a CustomField resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/devices/#devices): > Every piece of hardware which is installed within a site or rack exists in NetBox as a device.
The set of arguments for constructing a Device resource.
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/devices/#device-roles): > Devices can be organized by functional roles, which are fully customizable by the user.
The set of arguments for constructing a DeviceRole resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a DeviceType resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getInterfaces.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getInterfaces.
A collection of values returned by getInterfaces.
A collection of values returned by getInterfaces.
A collection of arguments for invoking getIpAddresses.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getIpAddresses.
A collection of values returned by getIpAddresses.
A collection of values returned by getIpAddresses.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getTenants.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getTenants.
A collection of values returned by getTenants.
A collection of values returned by getTenants.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getVirtualMachines.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getVirtualMachines.
A collection of values returned by getVirtualMachines.
A collection of values returned by getVirtualMachines.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a Interface resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/ipam/#ip-addresses): > An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask.
The set of arguments for constructing a IpAddress resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a IpamRole resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/ipam/#ip-ranges): > This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses.
The set of arguments for constructing a IpRange resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A collection of arguments for invoking getCluster.
A collection of arguments for invoking getClusterGroup.
A collection of arguments for invoking getClusterGroup.
A collection of values returned by getClusterGroup.
A collection of values returned by getClusterGroup.
A collection of arguments for invoking getCluster.
A collection of values returned by getCluster.
A collection of values returned by getCluster.
A collection of arguments for invoking getClusterType.
A collection of arguments for invoking getClusterType.
A collection of values returned by getClusterType.
A collection of values returned by getClusterType.
A collection of arguments for invoking getDeviceRole.
A collection of arguments for invoking getDeviceRole.
A collection of values returned by getDeviceRole.
A collection of values returned by getDeviceRole.
A collection of arguments for invoking getDeviceType.
A collection of arguments for invoking getDeviceType.
A collection of values returned by getDeviceType.
A collection of values returned by getDeviceType.
A collection of arguments for invoking getIpRange.
A collection of arguments for invoking getIpRange.
A collection of values returned by getIpRange.
A collection of values returned by getIpRange.
A collection of arguments for invoking getPlatform.
A collection of arguments for invoking getPlatform.
A collection of values returned by getPlatform.
A collection of values returned by getPlatform.
A collection of arguments for invoking getPrefix.
A collection of arguments for invoking getPrefix.
A collection of values returned by getPrefix.
A collection of values returned by getPrefix.
A collection of arguments for invoking getRegion.
A collection of arguments for invoking getRegion.
A collection of values returned by getRegion.
A collection of values returned by getRegion.
A collection of arguments for invoking getSite.
A collection of arguments for invoking getSite.
A collection of values returned by getSite.
A collection of values returned by getSite.
A collection of arguments for invoking getTag.
A collection of arguments for invoking getTag.
A collection of values returned by getTag.
A collection of values returned by getTag.
A collection of arguments for invoking getTenant.
A collection of arguments for invoking getTenantGroup.
A collection of arguments for invoking getTenantGroup.
A collection of values returned by getTenantGroup.
A collection of values returned by getTenantGroup.
A collection of arguments for invoking getTenant.
A collection of values returned by getTenant.
A collection of values returned by getTenant.
A collection of arguments for invoking getVlan.
A collection of arguments for invoking getVlan.
A collection of values returned by getVlan.
A collection of values returned by getVlan.
A collection of arguments for invoking getVrf.
A collection of arguments for invoking getVrf.
A collection of values returned by getVrf.
A collection of values returned by getVrf.
No description provided by the author
The set of arguments for constructing a Manufacturer resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/devices/#platforms): > A platform defines the type of software running on a device or virtual machine.
The set of arguments for constructing a Platform resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/ipam/#prefixes): > A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g.
The set of arguments for constructing a Prefix resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This resource is used to define the primary IP for a given virtual machine.
The set of arguments for constructing a PrimaryIp resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The provider type for the netbox package.
The set of arguments for constructing a Provider resource.
No description provided by the author
No description provided by the author
The set of arguments for constructing a Region resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a Rir resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/services/#services): > A service represents a layer four TCP or UDP service available on a device or virtual machine.
The set of arguments for constructing a Service resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.NewSite(ctx, "example1", &netbox.SiteArgs{ Asn: pulumi.Int(1337), Facility: pulumi.String("Data center"), Latitude: pulumi.Float64(-45.4085), Longitude: pulumi.Float64(30.1496), Status: pulumi.String("staging"), Timezone: pulumi.String("Africa/Johannesburg"), }) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a Site resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.NewTag(ctx, "dmz", &netbox.TagArgs{ ColorHex: pulumi.String("ff00ff"), }) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a Tag resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.NewTenant(ctx, "customerA", nil) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a Tenant resource.
No description provided by the author
No description provided by the author
The set of arguments for constructing a TenantGroup resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a Token resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a User resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The set of arguments for constructing a VirtualMachine resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.NewVlan(ctx, "example1", &netbox.VlanArgs{ Vid: pulumi.Int(1777), Tags: pulumi.StringArray{}, }) if err != nil { return err } _, err = netbox.NewVlan(ctx, "example2", &netbox.VlanArgs{ Vid: pulumi.Int(1778), Status: pulumi.String("reserved"), Description: pulumi.String("Reserved example VLAN"), TenantId: pulumi.Any(netbox_tenant.Ex.Id), SiteId: pulumi.Any(netbox_site.Ex.Id), Tags: pulumi.StringArray{ pulumi.Any(netbox_tag.Ex.Name), }, }) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a Vlan resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
## Example Usage ```go package main import ( "github.com/hbjydev/pulumi-netbox/sdk/go/netbox" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := netbox.NewVrf(ctx, "custAProd", &netbox.VrfArgs{ Tags: pulumi.StringArray{ pulumi.String("customer-a"), pulumi.String("prod"), }, }) if err != nil { return err } return nil }) } ```.
The set of arguments for constructing a Vrf resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

AggregateArrayInput is an input type that accepts AggregateArray and AggregateArrayOutput values.
No description provided by the author
AggregateMapInput is an input type that accepts AggregateMap and AggregateMapOutput values.
AvailableIpAddressArrayInput is an input type that accepts AvailableIpAddressArray and AvailableIpAddressArrayOutput values.
No description provided by the author
AvailableIpAddressMapInput is an input type that accepts AvailableIpAddressMap and AvailableIpAddressMapOutput values.
AvailablePrefixArrayInput is an input type that accepts AvailablePrefixArray and AvailablePrefixArrayOutput values.
No description provided by the author
AvailablePrefixMapInput is an input type that accepts AvailablePrefixMap and AvailablePrefixMapOutput values.
CircuitArrayInput is an input type that accepts CircuitArray and CircuitArrayOutput values.
No description provided by the author
CircuitMapInput is an input type that accepts CircuitMap and CircuitMapOutput values.
CircuitProviderArrayInput is an input type that accepts CircuitProviderArray and CircuitProviderArrayOutput values.
No description provided by the author
CircuitProviderMapInput is an input type that accepts CircuitProviderMap and CircuitProviderMapOutput values.
CircuitTerminationArrayInput is an input type that accepts CircuitTerminationArray and CircuitTerminationArrayOutput values.
No description provided by the author
CircuitTerminationMapInput is an input type that accepts CircuitTerminationMap and CircuitTerminationMapOutput values.
CircuitTypeArrayInput is an input type that accepts CircuitTypeArray and CircuitTypeArrayOutput values.
No description provided by the author
CircuitTypeMapInput is an input type that accepts CircuitTypeMap and CircuitTypeMapOutput values.
ClusterArrayInput is an input type that accepts ClusterArray and ClusterArrayOutput values.
ClusterGroupArrayInput is an input type that accepts ClusterGroupArray and ClusterGroupArrayOutput values.
No description provided by the author
ClusterGroupMapInput is an input type that accepts ClusterGroupMap and ClusterGroupMapOutput values.
No description provided by the author
ClusterMapInput is an input type that accepts ClusterMap and ClusterMapOutput values.
ClusterTypeArrayInput is an input type that accepts ClusterTypeArray and ClusterTypeArrayOutput values.
No description provided by the author
ClusterTypeMapInput is an input type that accepts ClusterTypeMap and ClusterTypeMapOutput values.
CustomFieldArrayInput is an input type that accepts CustomFieldArray and CustomFieldArrayOutput values.
No description provided by the author
CustomFieldMapInput is an input type that accepts CustomFieldMap and CustomFieldMapOutput values.
DeviceArrayInput is an input type that accepts DeviceArray and DeviceArrayOutput values.
No description provided by the author
DeviceMapInput is an input type that accepts DeviceMap and DeviceMapOutput values.
DeviceRoleArrayInput is an input type that accepts DeviceRoleArray and DeviceRoleArrayOutput values.
No description provided by the author
DeviceRoleMapInput is an input type that accepts DeviceRoleMap and DeviceRoleMapOutput values.
DeviceTypeArrayInput is an input type that accepts DeviceTypeArray and DeviceTypeArrayOutput values.
No description provided by the author
DeviceTypeMapInput is an input type that accepts DeviceTypeMap and DeviceTypeMapOutput values.
GetInterfacesFilterArrayInput is an input type that accepts GetInterfacesFilterArray and GetInterfacesFilterArrayOutput values.
GetInterfacesFilterInput is an input type that accepts GetInterfacesFilterArgs and GetInterfacesFilterOutput values.
GetInterfacesInterfaceArrayInput is an input type that accepts GetInterfacesInterfaceArray and GetInterfacesInterfaceArrayOutput values.
GetInterfacesInterfaceInput is an input type that accepts GetInterfacesInterfaceArgs and GetInterfacesInterfaceOutput values.
GetInterfacesInterfaceTaggedVlanArrayInput is an input type that accepts GetInterfacesInterfaceTaggedVlanArray and GetInterfacesInterfaceTaggedVlanArrayOutput values.
GetInterfacesInterfaceTaggedVlanInput is an input type that accepts GetInterfacesInterfaceTaggedVlanArgs and GetInterfacesInterfaceTaggedVlanOutput values.
GetInterfacesInterfaceUntaggedVlanArrayInput is an input type that accepts GetInterfacesInterfaceUntaggedVlanArray and GetInterfacesInterfaceUntaggedVlanArrayOutput values.
GetInterfacesInterfaceUntaggedVlanInput is an input type that accepts GetInterfacesInterfaceUntaggedVlanArgs and GetInterfacesInterfaceUntaggedVlanOutput values.
GetIpAddressesFilterArrayInput is an input type that accepts GetIpAddressesFilterArray and GetIpAddressesFilterArrayOutput values.
GetIpAddressesFilterInput is an input type that accepts GetIpAddressesFilterArgs and GetIpAddressesFilterOutput values.
GetIpAddressesIpAddressArrayInput is an input type that accepts GetIpAddressesIpAddressArray and GetIpAddressesIpAddressArrayOutput values.
GetIpAddressesIpAddressInput is an input type that accepts GetIpAddressesIpAddressArgs and GetIpAddressesIpAddressOutput values.
GetIpAddressesIpAddressTenantArrayInput is an input type that accepts GetIpAddressesIpAddressTenantArray and GetIpAddressesIpAddressTenantArrayOutput values.
GetIpAddressesIpAddressTenantInput is an input type that accepts GetIpAddressesIpAddressTenantArgs and GetIpAddressesIpAddressTenantOutput values.
GetRegionFilterArrayInput is an input type that accepts GetRegionFilterArray and GetRegionFilterArrayOutput values.
GetRegionFilterInput is an input type that accepts GetRegionFilterArgs and GetRegionFilterOutput values.
GetTenantsFilterArrayInput is an input type that accepts GetTenantsFilterArray and GetTenantsFilterArrayOutput values.
GetTenantsFilterInput is an input type that accepts GetTenantsFilterArgs and GetTenantsFilterOutput values.
GetTenantsTenantArrayInput is an input type that accepts GetTenantsTenantArray and GetTenantsTenantArrayOutput values.
GetTenantsTenantInput is an input type that accepts GetTenantsTenantArgs and GetTenantsTenantOutput values.
GetTenantsTenantTenantGroupArrayInput is an input type that accepts GetTenantsTenantTenantGroupArray and GetTenantsTenantTenantGroupArrayOutput values.
GetTenantsTenantTenantGroupInput is an input type that accepts GetTenantsTenantTenantGroupArgs and GetTenantsTenantTenantGroupOutput values.
GetVirtualMachinesFilterArrayInput is an input type that accepts GetVirtualMachinesFilterArray and GetVirtualMachinesFilterArrayOutput values.
GetVirtualMachinesFilterInput is an input type that accepts GetVirtualMachinesFilterArgs and GetVirtualMachinesFilterOutput values.
GetVirtualMachinesVmArrayInput is an input type that accepts GetVirtualMachinesVmArray and GetVirtualMachinesVmArrayOutput values.
GetVirtualMachinesVmInput is an input type that accepts GetVirtualMachinesVmArgs and GetVirtualMachinesVmOutput values.
InterfaceArrayInput is an input type that accepts InterfaceArray and InterfaceArrayOutput values.
No description provided by the author
InterfaceMapInput is an input type that accepts InterfaceMap and InterfaceMapOutput values.
IpAddressArrayInput is an input type that accepts IpAddressArray and IpAddressArrayOutput values.
No description provided by the author
IpAddressMapInput is an input type that accepts IpAddressMap and IpAddressMapOutput values.
IpamRoleArrayInput is an input type that accepts IpamRoleArray and IpamRoleArrayOutput values.
No description provided by the author
IpamRoleMapInput is an input type that accepts IpamRoleMap and IpamRoleMapOutput values.
IpRangeArrayInput is an input type that accepts IpRangeArray and IpRangeArrayOutput values.
No description provided by the author
IpRangeMapInput is an input type that accepts IpRangeMap and IpRangeMapOutput values.
ManufacturerArrayInput is an input type that accepts ManufacturerArray and ManufacturerArrayOutput values.
No description provided by the author
ManufacturerMapInput is an input type that accepts ManufacturerMap and ManufacturerMapOutput values.
PlatformArrayInput is an input type that accepts PlatformArray and PlatformArrayOutput values.
No description provided by the author
PlatformMapInput is an input type that accepts PlatformMap and PlatformMapOutput values.
PrefixArrayInput is an input type that accepts PrefixArray and PrefixArrayOutput values.
No description provided by the author
PrefixMapInput is an input type that accepts PrefixMap and PrefixMapOutput values.
PrimaryIpArrayInput is an input type that accepts PrimaryIpArray and PrimaryIpArrayOutput values.
No description provided by the author
PrimaryIpMapInput is an input type that accepts PrimaryIpMap and PrimaryIpMapOutput values.
No description provided by the author
RegionArrayInput is an input type that accepts RegionArray and RegionArrayOutput values.
No description provided by the author
RegionMapInput is an input type that accepts RegionMap and RegionMapOutput values.
RirArrayInput is an input type that accepts RirArray and RirArrayOutput values.
No description provided by the author
RirMapInput is an input type that accepts RirMap and RirMapOutput values.
ServiceArrayInput is an input type that accepts ServiceArray and ServiceArrayOutput values.
No description provided by the author
ServiceMapInput is an input type that accepts ServiceMap and ServiceMapOutput values.
SiteArrayInput is an input type that accepts SiteArray and SiteArrayOutput values.
No description provided by the author
SiteMapInput is an input type that accepts SiteMap and SiteMapOutput values.
TagArrayInput is an input type that accepts TagArray and TagArrayOutput values.
No description provided by the author
TagMapInput is an input type that accepts TagMap and TagMapOutput values.
TenantArrayInput is an input type that accepts TenantArray and TenantArrayOutput values.
TenantGroupArrayInput is an input type that accepts TenantGroupArray and TenantGroupArrayOutput values.
No description provided by the author
TenantGroupMapInput is an input type that accepts TenantGroupMap and TenantGroupMapOutput values.
No description provided by the author
TenantMapInput is an input type that accepts TenantMap and TenantMapOutput values.
TokenArrayInput is an input type that accepts TokenArray and TokenArrayOutput values.
No description provided by the author
TokenMapInput is an input type that accepts TokenMap and TokenMapOutput values.
UserArrayInput is an input type that accepts UserArray and UserArrayOutput values.
No description provided by the author
UserMapInput is an input type that accepts UserMap and UserMapOutput values.
VirtualMachineArrayInput is an input type that accepts VirtualMachineArray and VirtualMachineArrayOutput values.
No description provided by the author
VirtualMachineMapInput is an input type that accepts VirtualMachineMap and VirtualMachineMapOutput values.
VlanArrayInput is an input type that accepts VlanArray and VlanArrayOutput values.
No description provided by the author
VlanMapInput is an input type that accepts VlanMap and VlanMapOutput values.
VrfArrayInput is an input type that accepts VrfArray and VrfArrayOutput values.
No description provided by the author
VrfMapInput is an input type that accepts VrfMap and VrfMapOutput values.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author