ipam

package
v0.0.0-...-a632b15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Aggregate

type Aggregate struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput   `pulumi:"description"`
	Prefix      pulumi.StringOutput      `pulumi:"prefix"`
	RirId       pulumi.IntPtrOutput      `pulumi:"rirId"`
	Tags        pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls    pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId    pulumi.IntPtrOutput      `pulumi:"tenantId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#aggregates):

> NetBox allows us to specify the portions of IP space that are interesting to us by defining aggregates. Typically, an aggregate will correspond to either an allocation of public (globally routable) IP space granted by a regional authority, or a private (internally-routable) designation.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := ipam.NewRir(ctx, "test", &ipam.RirArgs{
			Name: pulumi.String("testrir"),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewAggregate(ctx, "test", &ipam.AggregateArgs{
			Prefix:      pulumi.String("1.1.1.0/25"),
			Description: pulumi.String("my description"),
			RirId:       test.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetAggregate

func GetAggregate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AggregateState, opts ...pulumi.ResourceOption) (*Aggregate, error)

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).

func NewAggregate

func NewAggregate(ctx *pulumi.Context,
	name string, args *AggregateArgs, opts ...pulumi.ResourceOption) (*Aggregate, error)

NewAggregate registers a new resource with the given unique name, arguments, and options.

func (*Aggregate) ElementType

func (*Aggregate) ElementType() reflect.Type

func (*Aggregate) ToAggregateOutput

func (i *Aggregate) ToAggregateOutput() AggregateOutput

func (*Aggregate) ToAggregateOutputWithContext

func (i *Aggregate) ToAggregateOutputWithContext(ctx context.Context) AggregateOutput

type AggregateArgs

type AggregateArgs struct {
	Description pulumi.StringPtrInput
	Prefix      pulumi.StringInput
	RirId       pulumi.IntPtrInput
	Tags        pulumi.StringArrayInput
	TenantId    pulumi.IntPtrInput
}

The set of arguments for constructing a Aggregate resource.

func (AggregateArgs) ElementType

func (AggregateArgs) ElementType() reflect.Type

type AggregateArray

type AggregateArray []AggregateInput

func (AggregateArray) ElementType

func (AggregateArray) ElementType() reflect.Type

func (AggregateArray) ToAggregateArrayOutput

func (i AggregateArray) ToAggregateArrayOutput() AggregateArrayOutput

func (AggregateArray) ToAggregateArrayOutputWithContext

func (i AggregateArray) ToAggregateArrayOutputWithContext(ctx context.Context) AggregateArrayOutput

type AggregateArrayInput

type AggregateArrayInput interface {
	pulumi.Input

	ToAggregateArrayOutput() AggregateArrayOutput
	ToAggregateArrayOutputWithContext(context.Context) AggregateArrayOutput
}

AggregateArrayInput is an input type that accepts AggregateArray and AggregateArrayOutput values. You can construct a concrete instance of `AggregateArrayInput` via:

AggregateArray{ AggregateArgs{...} }

type AggregateArrayOutput

type AggregateArrayOutput struct{ *pulumi.OutputState }

func (AggregateArrayOutput) ElementType

func (AggregateArrayOutput) ElementType() reflect.Type

func (AggregateArrayOutput) Index

func (AggregateArrayOutput) ToAggregateArrayOutput

func (o AggregateArrayOutput) ToAggregateArrayOutput() AggregateArrayOutput

func (AggregateArrayOutput) ToAggregateArrayOutputWithContext

func (o AggregateArrayOutput) ToAggregateArrayOutputWithContext(ctx context.Context) AggregateArrayOutput

type AggregateInput

type AggregateInput interface {
	pulumi.Input

	ToAggregateOutput() AggregateOutput
	ToAggregateOutputWithContext(ctx context.Context) AggregateOutput
}

type AggregateMap

type AggregateMap map[string]AggregateInput

func (AggregateMap) ElementType

func (AggregateMap) ElementType() reflect.Type

func (AggregateMap) ToAggregateMapOutput

func (i AggregateMap) ToAggregateMapOutput() AggregateMapOutput

func (AggregateMap) ToAggregateMapOutputWithContext

func (i AggregateMap) ToAggregateMapOutputWithContext(ctx context.Context) AggregateMapOutput

type AggregateMapInput

type AggregateMapInput interface {
	pulumi.Input

	ToAggregateMapOutput() AggregateMapOutput
	ToAggregateMapOutputWithContext(context.Context) AggregateMapOutput
}

AggregateMapInput is an input type that accepts AggregateMap and AggregateMapOutput values. You can construct a concrete instance of `AggregateMapInput` via:

AggregateMap{ "key": AggregateArgs{...} }

type AggregateMapOutput

type AggregateMapOutput struct{ *pulumi.OutputState }

func (AggregateMapOutput) ElementType

func (AggregateMapOutput) ElementType() reflect.Type

func (AggregateMapOutput) MapIndex

func (AggregateMapOutput) ToAggregateMapOutput

func (o AggregateMapOutput) ToAggregateMapOutput() AggregateMapOutput

func (AggregateMapOutput) ToAggregateMapOutputWithContext

func (o AggregateMapOutput) ToAggregateMapOutputWithContext(ctx context.Context) AggregateMapOutput

type AggregateOutput

type AggregateOutput struct{ *pulumi.OutputState }

func (AggregateOutput) Description

func (o AggregateOutput) Description() pulumi.StringPtrOutput

func (AggregateOutput) ElementType

func (AggregateOutput) ElementType() reflect.Type

func (AggregateOutput) Prefix

func (o AggregateOutput) Prefix() pulumi.StringOutput

func (AggregateOutput) RirId

func (AggregateOutput) Tags

func (AggregateOutput) TagsAlls

func (AggregateOutput) TenantId

func (o AggregateOutput) TenantId() pulumi.IntPtrOutput

func (AggregateOutput) ToAggregateOutput

func (o AggregateOutput) ToAggregateOutput() AggregateOutput

func (AggregateOutput) ToAggregateOutputWithContext

func (o AggregateOutput) ToAggregateOutputWithContext(ctx context.Context) AggregateOutput

type AggregateState

type AggregateState struct {
	Description pulumi.StringPtrInput
	Prefix      pulumi.StringPtrInput
	RirId       pulumi.IntPtrInput
	Tags        pulumi.StringArrayInput
	TagsAlls    pulumi.StringArrayInput
	TenantId    pulumi.IntPtrInput
}

func (AggregateState) ElementType

func (AggregateState) ElementType() reflect.Type

type Asn

type Asn struct {
	pulumi.CustomResourceState

	// Value for the AS Number record.
	Asn pulumi.IntOutput `pulumi:"asn"`
	// Comments field for the AS Number record.
	Comments pulumi.StringPtrOutput `pulumi:"comments"`
	// Description field for the AS Number record.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// ID for the RIR for the AS Number record.
	RirId    pulumi.IntOutput         `pulumi:"rirId"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#asn): > ASN is short for Autonomous System Number. This identifier is used in the BGP protocol to identify which "autonomous system" a particular prefix is originating and transiting through. > > The AS number model within NetBox allows you to model some of this real-world relationship.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := ipam.NewRir(ctx, "test", &ipam.RirArgs{
			Name: pulumi.String("testrir"),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewAsn(ctx, "test", &ipam.AsnArgs{
			Asn:         pulumi.Int(1337),
			RirId:       test.ID(),
			Description: pulumi.String("test"),
			Comments:    pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetAsn

func GetAsn(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AsnState, opts ...pulumi.ResourceOption) (*Asn, error)

GetAsn gets an existing Asn resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAsn

func NewAsn(ctx *pulumi.Context,
	name string, args *AsnArgs, opts ...pulumi.ResourceOption) (*Asn, error)

NewAsn registers a new resource with the given unique name, arguments, and options.

func (*Asn) ElementType

func (*Asn) ElementType() reflect.Type

func (*Asn) ToAsnOutput

func (i *Asn) ToAsnOutput() AsnOutput

func (*Asn) ToAsnOutputWithContext

func (i *Asn) ToAsnOutputWithContext(ctx context.Context) AsnOutput

type AsnArgs

type AsnArgs struct {
	// Value for the AS Number record.
	Asn pulumi.IntInput
	// Comments field for the AS Number record.
	Comments pulumi.StringPtrInput
	// Description field for the AS Number record.
	Description pulumi.StringPtrInput
	// ID for the RIR for the AS Number record.
	RirId pulumi.IntInput
	Tags  pulumi.StringArrayInput
}

The set of arguments for constructing a Asn resource.

func (AsnArgs) ElementType

func (AsnArgs) ElementType() reflect.Type

type AsnArray

type AsnArray []AsnInput

func (AsnArray) ElementType

func (AsnArray) ElementType() reflect.Type

func (AsnArray) ToAsnArrayOutput

func (i AsnArray) ToAsnArrayOutput() AsnArrayOutput

func (AsnArray) ToAsnArrayOutputWithContext

func (i AsnArray) ToAsnArrayOutputWithContext(ctx context.Context) AsnArrayOutput

type AsnArrayInput

type AsnArrayInput interface {
	pulumi.Input

	ToAsnArrayOutput() AsnArrayOutput
	ToAsnArrayOutputWithContext(context.Context) AsnArrayOutput
}

AsnArrayInput is an input type that accepts AsnArray and AsnArrayOutput values. You can construct a concrete instance of `AsnArrayInput` via:

AsnArray{ AsnArgs{...} }

type AsnArrayOutput

type AsnArrayOutput struct{ *pulumi.OutputState }

func (AsnArrayOutput) ElementType

func (AsnArrayOutput) ElementType() reflect.Type

func (AsnArrayOutput) Index

func (AsnArrayOutput) ToAsnArrayOutput

func (o AsnArrayOutput) ToAsnArrayOutput() AsnArrayOutput

func (AsnArrayOutput) ToAsnArrayOutputWithContext

func (o AsnArrayOutput) ToAsnArrayOutputWithContext(ctx context.Context) AsnArrayOutput

type AsnInput

type AsnInput interface {
	pulumi.Input

	ToAsnOutput() AsnOutput
	ToAsnOutputWithContext(ctx context.Context) AsnOutput
}

type AsnMap

type AsnMap map[string]AsnInput

func (AsnMap) ElementType

func (AsnMap) ElementType() reflect.Type

func (AsnMap) ToAsnMapOutput

func (i AsnMap) ToAsnMapOutput() AsnMapOutput

func (AsnMap) ToAsnMapOutputWithContext

func (i AsnMap) ToAsnMapOutputWithContext(ctx context.Context) AsnMapOutput

type AsnMapInput

type AsnMapInput interface {
	pulumi.Input

	ToAsnMapOutput() AsnMapOutput
	ToAsnMapOutputWithContext(context.Context) AsnMapOutput
}

AsnMapInput is an input type that accepts AsnMap and AsnMapOutput values. You can construct a concrete instance of `AsnMapInput` via:

AsnMap{ "key": AsnArgs{...} }

type AsnMapOutput

type AsnMapOutput struct{ *pulumi.OutputState }

func (AsnMapOutput) ElementType

func (AsnMapOutput) ElementType() reflect.Type

func (AsnMapOutput) MapIndex

func (o AsnMapOutput) MapIndex(k pulumi.StringInput) AsnOutput

func (AsnMapOutput) ToAsnMapOutput

func (o AsnMapOutput) ToAsnMapOutput() AsnMapOutput

func (AsnMapOutput) ToAsnMapOutputWithContext

func (o AsnMapOutput) ToAsnMapOutputWithContext(ctx context.Context) AsnMapOutput

type AsnOutput

type AsnOutput struct{ *pulumi.OutputState }

func (AsnOutput) Asn

func (o AsnOutput) Asn() pulumi.IntOutput

Value for the AS Number record.

func (AsnOutput) Comments

func (o AsnOutput) Comments() pulumi.StringPtrOutput

Comments field for the AS Number record.

func (AsnOutput) Description

func (o AsnOutput) Description() pulumi.StringPtrOutput

Description field for the AS Number record.

func (AsnOutput) ElementType

func (AsnOutput) ElementType() reflect.Type

func (AsnOutput) RirId

func (o AsnOutput) RirId() pulumi.IntOutput

ID for the RIR for the AS Number record.

func (AsnOutput) Tags

func (AsnOutput) TagsAlls

func (o AsnOutput) TagsAlls() pulumi.StringArrayOutput

func (AsnOutput) ToAsnOutput

func (o AsnOutput) ToAsnOutput() AsnOutput

func (AsnOutput) ToAsnOutputWithContext

func (o AsnOutput) ToAsnOutputWithContext(ctx context.Context) AsnOutput

type AsnState

type AsnState struct {
	// Value for the AS Number record.
	Asn pulumi.IntPtrInput
	// Comments field for the AS Number record.
	Comments pulumi.StringPtrInput
	// Description field for the AS Number record.
	Description pulumi.StringPtrInput
	// ID for the RIR for the AS Number record.
	RirId    pulumi.IntPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
}

func (AsnState) ElementType

func (AsnState) ElementType() reflect.Type

type AvailableIpAddress

type AvailableIpAddress struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrOutput    `pulumi:"deviceInterfaceId"`
	DnsName           pulumi.StringPtrOutput `pulumi:"dnsName"`
	// Required when `objectType` is set.
	InterfaceId pulumi.IntPtrOutput `pulumi:"interfaceId"`
	IpAddress   pulumi.StringOutput `pulumi:"ipAddress"`
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	IpRangeId pulumi.IntPtrOutput `pulumi:"ipRangeId"`
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrOutput `pulumi:"objectType"`
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	PrefixId pulumi.IntPtrOutput `pulumi:"prefixId"`
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrOutput `pulumi:"role"`
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`. Defaults to `active`.
	Status   pulumi.StringPtrOutput   `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrOutput `pulumi:"virtualMachineInterfaceId"`
	VrfId                     pulumi.IntPtrOutput `pulumi:"vrfId"`
}

Per [the docs](https://netbox.readthedocs.io/en/stable/models/ipam/ipaddress/):

> An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world. Like a prefix, an IP address can optionally be assigned to a VRF (otherwise, it will appear in the "global" table). IP addresses are automatically arranged under parent prefixes within their respective VRFs according to the IP hierarchya. > > Each IP address can also be assigned an operational status and a functional role. Statuses are hard-coded in NetBox and include the following: > * Active > * Reserved > * Deprecated > * DHCP > * SLAAC (IPv6 Stateless Address Autoconfiguration)

This resource will retrieve the next available IP address from a given prefix or IP range (specified by ID)

## Example Usage

### Creating an IP in a prefix ```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := ipam.LookupPrefix(ctx, &ipam.LookupPrefixArgs{
			Cidr: pulumi.StringRef("10.0.0.0/24"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ipam.NewAvailableIpAddress(ctx, "test", &ipam.AvailableIpAddressArgs{
			PrefixId: pulumi.Int(test.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetAvailableIpAddress

func GetAvailableIpAddress(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AvailableIpAddressState, opts ...pulumi.ResourceOption) (*AvailableIpAddress, error)

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).

func NewAvailableIpAddress

func NewAvailableIpAddress(ctx *pulumi.Context,
	name string, args *AvailableIpAddressArgs, opts ...pulumi.ResourceOption) (*AvailableIpAddress, error)

NewAvailableIpAddress registers a new resource with the given unique name, arguments, and options.

func (*AvailableIpAddress) ElementType

func (*AvailableIpAddress) ElementType() reflect.Type

func (*AvailableIpAddress) ToAvailableIpAddressOutput

func (i *AvailableIpAddress) ToAvailableIpAddressOutput() AvailableIpAddressOutput

func (*AvailableIpAddress) ToAvailableIpAddressOutputWithContext

func (i *AvailableIpAddress) ToAvailableIpAddressOutputWithContext(ctx context.Context) AvailableIpAddressOutput

type AvailableIpAddressArgs

type AvailableIpAddressArgs struct {
	Description pulumi.StringPtrInput
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrInput
	DnsName           pulumi.StringPtrInput
	// Required when `objectType` is set.
	InterfaceId pulumi.IntPtrInput
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	IpRangeId pulumi.IntPtrInput
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrInput
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	PrefixId pulumi.IntPtrInput
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrInput
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrInput
	VrfId                     pulumi.IntPtrInput
}

The set of arguments for constructing a AvailableIpAddress resource.

func (AvailableIpAddressArgs) ElementType

func (AvailableIpAddressArgs) ElementType() reflect.Type

type AvailableIpAddressArray

type AvailableIpAddressArray []AvailableIpAddressInput

func (AvailableIpAddressArray) ElementType

func (AvailableIpAddressArray) ElementType() reflect.Type

func (AvailableIpAddressArray) ToAvailableIpAddressArrayOutput

func (i AvailableIpAddressArray) ToAvailableIpAddressArrayOutput() AvailableIpAddressArrayOutput

func (AvailableIpAddressArray) ToAvailableIpAddressArrayOutputWithContext

func (i AvailableIpAddressArray) ToAvailableIpAddressArrayOutputWithContext(ctx context.Context) AvailableIpAddressArrayOutput

type AvailableIpAddressArrayInput

type AvailableIpAddressArrayInput interface {
	pulumi.Input

	ToAvailableIpAddressArrayOutput() AvailableIpAddressArrayOutput
	ToAvailableIpAddressArrayOutputWithContext(context.Context) AvailableIpAddressArrayOutput
}

AvailableIpAddressArrayInput is an input type that accepts AvailableIpAddressArray and AvailableIpAddressArrayOutput values. You can construct a concrete instance of `AvailableIpAddressArrayInput` via:

AvailableIpAddressArray{ AvailableIpAddressArgs{...} }

type AvailableIpAddressArrayOutput

type AvailableIpAddressArrayOutput struct{ *pulumi.OutputState }

func (AvailableIpAddressArrayOutput) ElementType

func (AvailableIpAddressArrayOutput) Index

func (AvailableIpAddressArrayOutput) ToAvailableIpAddressArrayOutput

func (o AvailableIpAddressArrayOutput) ToAvailableIpAddressArrayOutput() AvailableIpAddressArrayOutput

func (AvailableIpAddressArrayOutput) ToAvailableIpAddressArrayOutputWithContext

func (o AvailableIpAddressArrayOutput) ToAvailableIpAddressArrayOutputWithContext(ctx context.Context) AvailableIpAddressArrayOutput

type AvailableIpAddressInput

type AvailableIpAddressInput interface {
	pulumi.Input

	ToAvailableIpAddressOutput() AvailableIpAddressOutput
	ToAvailableIpAddressOutputWithContext(ctx context.Context) AvailableIpAddressOutput
}

type AvailableIpAddressMap

type AvailableIpAddressMap map[string]AvailableIpAddressInput

func (AvailableIpAddressMap) ElementType

func (AvailableIpAddressMap) ElementType() reflect.Type

func (AvailableIpAddressMap) ToAvailableIpAddressMapOutput

func (i AvailableIpAddressMap) ToAvailableIpAddressMapOutput() AvailableIpAddressMapOutput

func (AvailableIpAddressMap) ToAvailableIpAddressMapOutputWithContext

func (i AvailableIpAddressMap) ToAvailableIpAddressMapOutputWithContext(ctx context.Context) AvailableIpAddressMapOutput

type AvailableIpAddressMapInput

type AvailableIpAddressMapInput interface {
	pulumi.Input

	ToAvailableIpAddressMapOutput() AvailableIpAddressMapOutput
	ToAvailableIpAddressMapOutputWithContext(context.Context) AvailableIpAddressMapOutput
}

AvailableIpAddressMapInput is an input type that accepts AvailableIpAddressMap and AvailableIpAddressMapOutput values. You can construct a concrete instance of `AvailableIpAddressMapInput` via:

AvailableIpAddressMap{ "key": AvailableIpAddressArgs{...} }

type AvailableIpAddressMapOutput

type AvailableIpAddressMapOutput struct{ *pulumi.OutputState }

func (AvailableIpAddressMapOutput) ElementType

func (AvailableIpAddressMapOutput) MapIndex

func (AvailableIpAddressMapOutput) ToAvailableIpAddressMapOutput

func (o AvailableIpAddressMapOutput) ToAvailableIpAddressMapOutput() AvailableIpAddressMapOutput

func (AvailableIpAddressMapOutput) ToAvailableIpAddressMapOutputWithContext

func (o AvailableIpAddressMapOutput) ToAvailableIpAddressMapOutputWithContext(ctx context.Context) AvailableIpAddressMapOutput

type AvailableIpAddressOutput

type AvailableIpAddressOutput struct{ *pulumi.OutputState }

func (AvailableIpAddressOutput) Description

func (AvailableIpAddressOutput) DeviceInterfaceId

func (o AvailableIpAddressOutput) DeviceInterfaceId() pulumi.IntPtrOutput

Conflicts with `interfaceId` and `virtualMachineInterfaceId`.

func (AvailableIpAddressOutput) DnsName

func (AvailableIpAddressOutput) ElementType

func (AvailableIpAddressOutput) ElementType() reflect.Type

func (AvailableIpAddressOutput) InterfaceId

Required when `objectType` is set.

func (AvailableIpAddressOutput) IpAddress

func (AvailableIpAddressOutput) IpRangeId

Exactly one of `prefixId` or `ipRangeId` must be given.

func (AvailableIpAddressOutput) ObjectType

Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.

func (AvailableIpAddressOutput) PrefixId

Exactly one of `prefixId` or `ipRangeId` must be given.

func (AvailableIpAddressOutput) Role

Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.

func (AvailableIpAddressOutput) Status

Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`. Defaults to `active`.

func (AvailableIpAddressOutput) Tags

func (AvailableIpAddressOutput) TagsAlls

func (AvailableIpAddressOutput) TenantId

func (AvailableIpAddressOutput) ToAvailableIpAddressOutput

func (o AvailableIpAddressOutput) ToAvailableIpAddressOutput() AvailableIpAddressOutput

func (AvailableIpAddressOutput) ToAvailableIpAddressOutputWithContext

func (o AvailableIpAddressOutput) ToAvailableIpAddressOutputWithContext(ctx context.Context) AvailableIpAddressOutput

func (AvailableIpAddressOutput) VirtualMachineInterfaceId

func (o AvailableIpAddressOutput) VirtualMachineInterfaceId() pulumi.IntPtrOutput

Conflicts with `interfaceId` and `deviceInterfaceId`.

func (AvailableIpAddressOutput) VrfId

type AvailableIpAddressState

type AvailableIpAddressState struct {
	Description pulumi.StringPtrInput
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrInput
	DnsName           pulumi.StringPtrInput
	// Required when `objectType` is set.
	InterfaceId pulumi.IntPtrInput
	IpAddress   pulumi.StringPtrInput
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	IpRangeId pulumi.IntPtrInput
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrInput
	// Exactly one of `prefixId` or `ipRangeId` must be given.
	PrefixId pulumi.IntPtrInput
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrInput
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrInput
	VrfId                     pulumi.IntPtrInput
}

func (AvailableIpAddressState) ElementType

func (AvailableIpAddressState) ElementType() reflect.Type

type AvailablePrefix

type AvailablePrefix struct {
	pulumi.CustomResourceState

	CustomFields pulumi.StringMapOutput `pulumi:"customFields"`
	Description  pulumi.StringPtrOutput `pulumi:"description"`
	IsPool       pulumi.BoolPtrOutput   `pulumi:"isPool"`
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId     pulumi.IntPtrOutput  `pulumi:"locationId"`
	MarkUtilized   pulumi.BoolPtrOutput `pulumi:"markUtilized"`
	ParentPrefixId pulumi.IntOutput     `pulumi:"parentPrefixId"`
	Prefix         pulumi.StringOutput  `pulumi:"prefix"`
	PrefixLength   pulumi.IntOutput     `pulumi:"prefixLength"`
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrOutput `pulumi:"regionId"`
	RoleId   pulumi.IntPtrOutput `pulumi:"roleId"`
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrOutput `pulumi:"siteGroupId"`
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrOutput `pulumi:"siteId"`
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringOutput      `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	VlanId   pulumi.IntPtrOutput      `pulumi:"vlanId"`
	VrfId    pulumi.IntPtrOutput      `pulumi:"vrfId"`
}

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := ipam.LookupPrefix(ctx, &ipam.LookupPrefixArgs{
			Cidr: pulumi.StringRef("10.0.0.0/24"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ipam.NewAvailablePrefix(ctx, "test", &ipam.AvailablePrefixArgs{
			ParentPrefixId: pulumi.Int(test.Id),
			PrefixLength:   pulumi.Int(25),
			Status:         pulumi.String("active"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetAvailablePrefix

func GetAvailablePrefix(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AvailablePrefixState, opts ...pulumi.ResourceOption) (*AvailablePrefix, error)

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).

func NewAvailablePrefix

func NewAvailablePrefix(ctx *pulumi.Context,
	name string, args *AvailablePrefixArgs, opts ...pulumi.ResourceOption) (*AvailablePrefix, error)

NewAvailablePrefix registers a new resource with the given unique name, arguments, and options.

func (*AvailablePrefix) ElementType

func (*AvailablePrefix) ElementType() reflect.Type

func (*AvailablePrefix) ToAvailablePrefixOutput

func (i *AvailablePrefix) ToAvailablePrefixOutput() AvailablePrefixOutput

func (*AvailablePrefix) ToAvailablePrefixOutputWithContext

func (i *AvailablePrefix) ToAvailablePrefixOutputWithContext(ctx context.Context) AvailablePrefixOutput

type AvailablePrefixArgs

type AvailablePrefixArgs struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	IsPool       pulumi.BoolPtrInput
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId     pulumi.IntPtrInput
	MarkUtilized   pulumi.BoolPtrInput
	ParentPrefixId pulumi.IntInput
	PrefixLength   pulumi.IntInput
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrInput
	RoleId   pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrInput
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VlanId   pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

The set of arguments for constructing a AvailablePrefix resource.

func (AvailablePrefixArgs) ElementType

func (AvailablePrefixArgs) ElementType() reflect.Type

type AvailablePrefixArray

type AvailablePrefixArray []AvailablePrefixInput

func (AvailablePrefixArray) ElementType

func (AvailablePrefixArray) ElementType() reflect.Type

func (AvailablePrefixArray) ToAvailablePrefixArrayOutput

func (i AvailablePrefixArray) ToAvailablePrefixArrayOutput() AvailablePrefixArrayOutput

func (AvailablePrefixArray) ToAvailablePrefixArrayOutputWithContext

func (i AvailablePrefixArray) ToAvailablePrefixArrayOutputWithContext(ctx context.Context) AvailablePrefixArrayOutput

type AvailablePrefixArrayInput

type AvailablePrefixArrayInput interface {
	pulumi.Input

	ToAvailablePrefixArrayOutput() AvailablePrefixArrayOutput
	ToAvailablePrefixArrayOutputWithContext(context.Context) AvailablePrefixArrayOutput
}

AvailablePrefixArrayInput is an input type that accepts AvailablePrefixArray and AvailablePrefixArrayOutput values. You can construct a concrete instance of `AvailablePrefixArrayInput` via:

AvailablePrefixArray{ AvailablePrefixArgs{...} }

type AvailablePrefixArrayOutput

type AvailablePrefixArrayOutput struct{ *pulumi.OutputState }

func (AvailablePrefixArrayOutput) ElementType

func (AvailablePrefixArrayOutput) ElementType() reflect.Type

func (AvailablePrefixArrayOutput) Index

func (AvailablePrefixArrayOutput) ToAvailablePrefixArrayOutput

func (o AvailablePrefixArrayOutput) ToAvailablePrefixArrayOutput() AvailablePrefixArrayOutput

func (AvailablePrefixArrayOutput) ToAvailablePrefixArrayOutputWithContext

func (o AvailablePrefixArrayOutput) ToAvailablePrefixArrayOutputWithContext(ctx context.Context) AvailablePrefixArrayOutput

type AvailablePrefixInput

type AvailablePrefixInput interface {
	pulumi.Input

	ToAvailablePrefixOutput() AvailablePrefixOutput
	ToAvailablePrefixOutputWithContext(ctx context.Context) AvailablePrefixOutput
}

type AvailablePrefixMap

type AvailablePrefixMap map[string]AvailablePrefixInput

func (AvailablePrefixMap) ElementType

func (AvailablePrefixMap) ElementType() reflect.Type

func (AvailablePrefixMap) ToAvailablePrefixMapOutput

func (i AvailablePrefixMap) ToAvailablePrefixMapOutput() AvailablePrefixMapOutput

func (AvailablePrefixMap) ToAvailablePrefixMapOutputWithContext

func (i AvailablePrefixMap) ToAvailablePrefixMapOutputWithContext(ctx context.Context) AvailablePrefixMapOutput

type AvailablePrefixMapInput

type AvailablePrefixMapInput interface {
	pulumi.Input

	ToAvailablePrefixMapOutput() AvailablePrefixMapOutput
	ToAvailablePrefixMapOutputWithContext(context.Context) AvailablePrefixMapOutput
}

AvailablePrefixMapInput is an input type that accepts AvailablePrefixMap and AvailablePrefixMapOutput values. You can construct a concrete instance of `AvailablePrefixMapInput` via:

AvailablePrefixMap{ "key": AvailablePrefixArgs{...} }

type AvailablePrefixMapOutput

type AvailablePrefixMapOutput struct{ *pulumi.OutputState }

func (AvailablePrefixMapOutput) ElementType

func (AvailablePrefixMapOutput) ElementType() reflect.Type

func (AvailablePrefixMapOutput) MapIndex

func (AvailablePrefixMapOutput) ToAvailablePrefixMapOutput

func (o AvailablePrefixMapOutput) ToAvailablePrefixMapOutput() AvailablePrefixMapOutput

func (AvailablePrefixMapOutput) ToAvailablePrefixMapOutputWithContext

func (o AvailablePrefixMapOutput) ToAvailablePrefixMapOutputWithContext(ctx context.Context) AvailablePrefixMapOutput

type AvailablePrefixOutput

type AvailablePrefixOutput struct{ *pulumi.OutputState }

func (AvailablePrefixOutput) CustomFields

func (o AvailablePrefixOutput) CustomFields() pulumi.StringMapOutput

func (AvailablePrefixOutput) Description

func (AvailablePrefixOutput) ElementType

func (AvailablePrefixOutput) ElementType() reflect.Type

func (AvailablePrefixOutput) IsPool

func (AvailablePrefixOutput) LocationId

func (o AvailablePrefixOutput) LocationId() pulumi.IntPtrOutput

Conflicts with `siteId`, `siteGroupId` and `regionId`.

func (AvailablePrefixOutput) MarkUtilized

func (o AvailablePrefixOutput) MarkUtilized() pulumi.BoolPtrOutput

func (AvailablePrefixOutput) ParentPrefixId

func (o AvailablePrefixOutput) ParentPrefixId() pulumi.IntOutput

func (AvailablePrefixOutput) Prefix

func (AvailablePrefixOutput) PrefixLength

func (o AvailablePrefixOutput) PrefixLength() pulumi.IntOutput

func (AvailablePrefixOutput) RegionId

Conflicts with `locationId`, `siteId` and `siteGroupId`.

func (AvailablePrefixOutput) RoleId

func (AvailablePrefixOutput) SiteGroupId

func (o AvailablePrefixOutput) SiteGroupId() pulumi.IntPtrOutput

Conflicts with `locationId`, `siteId` and `regionId`.

func (AvailablePrefixOutput) SiteId

Conflicts with `locationId`, `siteGroupId` and `regionId`.

func (AvailablePrefixOutput) Status

Valid values are `active`, `container`, `reserved` and `deprecated`.

func (AvailablePrefixOutput) Tags

func (AvailablePrefixOutput) TagsAlls

func (AvailablePrefixOutput) TenantId

func (AvailablePrefixOutput) ToAvailablePrefixOutput

func (o AvailablePrefixOutput) ToAvailablePrefixOutput() AvailablePrefixOutput

func (AvailablePrefixOutput) ToAvailablePrefixOutputWithContext

func (o AvailablePrefixOutput) ToAvailablePrefixOutputWithContext(ctx context.Context) AvailablePrefixOutput

func (AvailablePrefixOutput) VlanId

func (AvailablePrefixOutput) VrfId

type AvailablePrefixState

type AvailablePrefixState struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	IsPool       pulumi.BoolPtrInput
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId     pulumi.IntPtrInput
	MarkUtilized   pulumi.BoolPtrInput
	ParentPrefixId pulumi.IntPtrInput
	Prefix         pulumi.StringPtrInput
	PrefixLength   pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrInput
	RoleId   pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrInput
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VlanId   pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

func (AvailablePrefixState) ElementType

func (AvailablePrefixState) ElementType() reflect.Type

type GetAsnsArgs

type GetAsnsArgs struct {
	Filters []GetAsnsFilter `pulumi:"filters"`
	// Defaults to `0`.
	Limit *int `pulumi:"limit"`
}

A collection of arguments for invoking getAsns.

type GetAsnsAsn

type GetAsnsAsn struct {
	Asn   int      `pulumi:"asn"`
	Id    int      `pulumi:"id"`
	RirId int      `pulumi:"rirId"`
	Tags  []string `pulumi:"tags"`
}

type GetAsnsAsnArgs

type GetAsnsAsnArgs struct {
	Asn   pulumi.IntInput         `pulumi:"asn"`
	Id    pulumi.IntInput         `pulumi:"id"`
	RirId pulumi.IntInput         `pulumi:"rirId"`
	Tags  pulumi.StringArrayInput `pulumi:"tags"`
}

func (GetAsnsAsnArgs) ElementType

func (GetAsnsAsnArgs) ElementType() reflect.Type

func (GetAsnsAsnArgs) ToGetAsnsAsnOutput

func (i GetAsnsAsnArgs) ToGetAsnsAsnOutput() GetAsnsAsnOutput

func (GetAsnsAsnArgs) ToGetAsnsAsnOutputWithContext

func (i GetAsnsAsnArgs) ToGetAsnsAsnOutputWithContext(ctx context.Context) GetAsnsAsnOutput

type GetAsnsAsnArray

type GetAsnsAsnArray []GetAsnsAsnInput

func (GetAsnsAsnArray) ElementType

func (GetAsnsAsnArray) ElementType() reflect.Type

func (GetAsnsAsnArray) ToGetAsnsAsnArrayOutput

func (i GetAsnsAsnArray) ToGetAsnsAsnArrayOutput() GetAsnsAsnArrayOutput

func (GetAsnsAsnArray) ToGetAsnsAsnArrayOutputWithContext

func (i GetAsnsAsnArray) ToGetAsnsAsnArrayOutputWithContext(ctx context.Context) GetAsnsAsnArrayOutput

type GetAsnsAsnArrayInput

type GetAsnsAsnArrayInput interface {
	pulumi.Input

	ToGetAsnsAsnArrayOutput() GetAsnsAsnArrayOutput
	ToGetAsnsAsnArrayOutputWithContext(context.Context) GetAsnsAsnArrayOutput
}

GetAsnsAsnArrayInput is an input type that accepts GetAsnsAsnArray and GetAsnsAsnArrayOutput values. You can construct a concrete instance of `GetAsnsAsnArrayInput` via:

GetAsnsAsnArray{ GetAsnsAsnArgs{...} }

type GetAsnsAsnArrayOutput

type GetAsnsAsnArrayOutput struct{ *pulumi.OutputState }

func (GetAsnsAsnArrayOutput) ElementType

func (GetAsnsAsnArrayOutput) ElementType() reflect.Type

func (GetAsnsAsnArrayOutput) Index

func (GetAsnsAsnArrayOutput) ToGetAsnsAsnArrayOutput

func (o GetAsnsAsnArrayOutput) ToGetAsnsAsnArrayOutput() GetAsnsAsnArrayOutput

func (GetAsnsAsnArrayOutput) ToGetAsnsAsnArrayOutputWithContext

func (o GetAsnsAsnArrayOutput) ToGetAsnsAsnArrayOutputWithContext(ctx context.Context) GetAsnsAsnArrayOutput

type GetAsnsAsnInput

type GetAsnsAsnInput interface {
	pulumi.Input

	ToGetAsnsAsnOutput() GetAsnsAsnOutput
	ToGetAsnsAsnOutputWithContext(context.Context) GetAsnsAsnOutput
}

GetAsnsAsnInput is an input type that accepts GetAsnsAsnArgs and GetAsnsAsnOutput values. You can construct a concrete instance of `GetAsnsAsnInput` via:

GetAsnsAsnArgs{...}

type GetAsnsAsnOutput

type GetAsnsAsnOutput struct{ *pulumi.OutputState }

func (GetAsnsAsnOutput) Asn

func (GetAsnsAsnOutput) ElementType

func (GetAsnsAsnOutput) ElementType() reflect.Type

func (GetAsnsAsnOutput) Id

func (GetAsnsAsnOutput) RirId

func (o GetAsnsAsnOutput) RirId() pulumi.IntOutput

func (GetAsnsAsnOutput) Tags

func (GetAsnsAsnOutput) ToGetAsnsAsnOutput

func (o GetAsnsAsnOutput) ToGetAsnsAsnOutput() GetAsnsAsnOutput

func (GetAsnsAsnOutput) ToGetAsnsAsnOutputWithContext

func (o GetAsnsAsnOutput) ToGetAsnsAsnOutputWithContext(ctx context.Context) GetAsnsAsnOutput

type GetAsnsFilter

type GetAsnsFilter struct {
	Name  string `pulumi:"name"`
	Value string `pulumi:"value"`
}

type GetAsnsFilterArgs

type GetAsnsFilterArgs struct {
	Name  pulumi.StringInput `pulumi:"name"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetAsnsFilterArgs) ElementType

func (GetAsnsFilterArgs) ElementType() reflect.Type

func (GetAsnsFilterArgs) ToGetAsnsFilterOutput

func (i GetAsnsFilterArgs) ToGetAsnsFilterOutput() GetAsnsFilterOutput

func (GetAsnsFilterArgs) ToGetAsnsFilterOutputWithContext

func (i GetAsnsFilterArgs) ToGetAsnsFilterOutputWithContext(ctx context.Context) GetAsnsFilterOutput

type GetAsnsFilterArray

type GetAsnsFilterArray []GetAsnsFilterInput

func (GetAsnsFilterArray) ElementType

func (GetAsnsFilterArray) ElementType() reflect.Type

func (GetAsnsFilterArray) ToGetAsnsFilterArrayOutput

func (i GetAsnsFilterArray) ToGetAsnsFilterArrayOutput() GetAsnsFilterArrayOutput

func (GetAsnsFilterArray) ToGetAsnsFilterArrayOutputWithContext

func (i GetAsnsFilterArray) ToGetAsnsFilterArrayOutputWithContext(ctx context.Context) GetAsnsFilterArrayOutput

type GetAsnsFilterArrayInput

type GetAsnsFilterArrayInput interface {
	pulumi.Input

	ToGetAsnsFilterArrayOutput() GetAsnsFilterArrayOutput
	ToGetAsnsFilterArrayOutputWithContext(context.Context) GetAsnsFilterArrayOutput
}

GetAsnsFilterArrayInput is an input type that accepts GetAsnsFilterArray and GetAsnsFilterArrayOutput values. You can construct a concrete instance of `GetAsnsFilterArrayInput` via:

GetAsnsFilterArray{ GetAsnsFilterArgs{...} }

type GetAsnsFilterArrayOutput

type GetAsnsFilterArrayOutput struct{ *pulumi.OutputState }

func (GetAsnsFilterArrayOutput) ElementType

func (GetAsnsFilterArrayOutput) ElementType() reflect.Type

func (GetAsnsFilterArrayOutput) Index

func (GetAsnsFilterArrayOutput) ToGetAsnsFilterArrayOutput

func (o GetAsnsFilterArrayOutput) ToGetAsnsFilterArrayOutput() GetAsnsFilterArrayOutput

func (GetAsnsFilterArrayOutput) ToGetAsnsFilterArrayOutputWithContext

func (o GetAsnsFilterArrayOutput) ToGetAsnsFilterArrayOutputWithContext(ctx context.Context) GetAsnsFilterArrayOutput

type GetAsnsFilterInput

type GetAsnsFilterInput interface {
	pulumi.Input

	ToGetAsnsFilterOutput() GetAsnsFilterOutput
	ToGetAsnsFilterOutputWithContext(context.Context) GetAsnsFilterOutput
}

GetAsnsFilterInput is an input type that accepts GetAsnsFilterArgs and GetAsnsFilterOutput values. You can construct a concrete instance of `GetAsnsFilterInput` via:

GetAsnsFilterArgs{...}

type GetAsnsFilterOutput

type GetAsnsFilterOutput struct{ *pulumi.OutputState }

func (GetAsnsFilterOutput) ElementType

func (GetAsnsFilterOutput) ElementType() reflect.Type

func (GetAsnsFilterOutput) Name

func (GetAsnsFilterOutput) ToGetAsnsFilterOutput

func (o GetAsnsFilterOutput) ToGetAsnsFilterOutput() GetAsnsFilterOutput

func (GetAsnsFilterOutput) ToGetAsnsFilterOutputWithContext

func (o GetAsnsFilterOutput) ToGetAsnsFilterOutputWithContext(ctx context.Context) GetAsnsFilterOutput

func (GetAsnsFilterOutput) Value

type GetAsnsOutputArgs

type GetAsnsOutputArgs struct {
	Filters GetAsnsFilterArrayInput `pulumi:"filters"`
	// Defaults to `0`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getAsns.

func (GetAsnsOutputArgs) ElementType

func (GetAsnsOutputArgs) ElementType() reflect.Type

type GetAsnsResult

type GetAsnsResult struct {
	Asns    []GetAsnsAsn    `pulumi:"asns"`
	Filters []GetAsnsFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Defaults to `0`.
	Limit *int `pulumi:"limit"`
}

A collection of values returned by getAsns.

func GetAsns

func GetAsns(ctx *pulumi.Context, args *GetAsnsArgs, opts ...pulumi.InvokeOption) (*GetAsnsResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.GetAsns(ctx, &ipam.GetAsnsArgs{
			Filters: []ipam.GetAsnsFilter{
				{
					Name:  "asn__gte",
					Value: "1000",
				},
				{
					Name:  "asn__lte",
					Value: "2000",
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetAsnsResultOutput

type GetAsnsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAsns.

func (GetAsnsResultOutput) Asns

func (GetAsnsResultOutput) ElementType

func (GetAsnsResultOutput) ElementType() reflect.Type

func (GetAsnsResultOutput) Filters

func (GetAsnsResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetAsnsResultOutput) Limit

Defaults to `0`.

func (GetAsnsResultOutput) ToGetAsnsResultOutput

func (o GetAsnsResultOutput) ToGetAsnsResultOutput() GetAsnsResultOutput

func (GetAsnsResultOutput) ToGetAsnsResultOutputWithContext

func (o GetAsnsResultOutput) ToGetAsnsResultOutputWithContext(ctx context.Context) GetAsnsResultOutput

type GetAvailablePrefixPrefixesAvailable

type GetAvailablePrefixPrefixesAvailable struct {
	Family int    `pulumi:"family"`
	Prefix string `pulumi:"prefix"`
	VrfId  int    `pulumi:"vrfId"`
}

type GetAvailablePrefixPrefixesAvailableArgs

type GetAvailablePrefixPrefixesAvailableArgs struct {
	Family pulumi.IntInput    `pulumi:"family"`
	Prefix pulumi.StringInput `pulumi:"prefix"`
	VrfId  pulumi.IntInput    `pulumi:"vrfId"`
}

func (GetAvailablePrefixPrefixesAvailableArgs) ElementType

func (GetAvailablePrefixPrefixesAvailableArgs) ToGetAvailablePrefixPrefixesAvailableOutput

func (i GetAvailablePrefixPrefixesAvailableArgs) ToGetAvailablePrefixPrefixesAvailableOutput() GetAvailablePrefixPrefixesAvailableOutput

func (GetAvailablePrefixPrefixesAvailableArgs) ToGetAvailablePrefixPrefixesAvailableOutputWithContext

func (i GetAvailablePrefixPrefixesAvailableArgs) ToGetAvailablePrefixPrefixesAvailableOutputWithContext(ctx context.Context) GetAvailablePrefixPrefixesAvailableOutput

type GetAvailablePrefixPrefixesAvailableArray

type GetAvailablePrefixPrefixesAvailableArray []GetAvailablePrefixPrefixesAvailableInput

func (GetAvailablePrefixPrefixesAvailableArray) ElementType

func (GetAvailablePrefixPrefixesAvailableArray) ToGetAvailablePrefixPrefixesAvailableArrayOutput

func (i GetAvailablePrefixPrefixesAvailableArray) ToGetAvailablePrefixPrefixesAvailableArrayOutput() GetAvailablePrefixPrefixesAvailableArrayOutput

func (GetAvailablePrefixPrefixesAvailableArray) ToGetAvailablePrefixPrefixesAvailableArrayOutputWithContext

func (i GetAvailablePrefixPrefixesAvailableArray) ToGetAvailablePrefixPrefixesAvailableArrayOutputWithContext(ctx context.Context) GetAvailablePrefixPrefixesAvailableArrayOutput

type GetAvailablePrefixPrefixesAvailableArrayInput

type GetAvailablePrefixPrefixesAvailableArrayInput interface {
	pulumi.Input

	ToGetAvailablePrefixPrefixesAvailableArrayOutput() GetAvailablePrefixPrefixesAvailableArrayOutput
	ToGetAvailablePrefixPrefixesAvailableArrayOutputWithContext(context.Context) GetAvailablePrefixPrefixesAvailableArrayOutput
}

GetAvailablePrefixPrefixesAvailableArrayInput is an input type that accepts GetAvailablePrefixPrefixesAvailableArray and GetAvailablePrefixPrefixesAvailableArrayOutput values. You can construct a concrete instance of `GetAvailablePrefixPrefixesAvailableArrayInput` via:

GetAvailablePrefixPrefixesAvailableArray{ GetAvailablePrefixPrefixesAvailableArgs{...} }

type GetAvailablePrefixPrefixesAvailableArrayOutput

type GetAvailablePrefixPrefixesAvailableArrayOutput struct{ *pulumi.OutputState }

func (GetAvailablePrefixPrefixesAvailableArrayOutput) ElementType

func (GetAvailablePrefixPrefixesAvailableArrayOutput) Index

func (GetAvailablePrefixPrefixesAvailableArrayOutput) ToGetAvailablePrefixPrefixesAvailableArrayOutput

func (o GetAvailablePrefixPrefixesAvailableArrayOutput) ToGetAvailablePrefixPrefixesAvailableArrayOutput() GetAvailablePrefixPrefixesAvailableArrayOutput

func (GetAvailablePrefixPrefixesAvailableArrayOutput) ToGetAvailablePrefixPrefixesAvailableArrayOutputWithContext

func (o GetAvailablePrefixPrefixesAvailableArrayOutput) ToGetAvailablePrefixPrefixesAvailableArrayOutputWithContext(ctx context.Context) GetAvailablePrefixPrefixesAvailableArrayOutput

type GetAvailablePrefixPrefixesAvailableInput

type GetAvailablePrefixPrefixesAvailableInput interface {
	pulumi.Input

	ToGetAvailablePrefixPrefixesAvailableOutput() GetAvailablePrefixPrefixesAvailableOutput
	ToGetAvailablePrefixPrefixesAvailableOutputWithContext(context.Context) GetAvailablePrefixPrefixesAvailableOutput
}

GetAvailablePrefixPrefixesAvailableInput is an input type that accepts GetAvailablePrefixPrefixesAvailableArgs and GetAvailablePrefixPrefixesAvailableOutput values. You can construct a concrete instance of `GetAvailablePrefixPrefixesAvailableInput` via:

GetAvailablePrefixPrefixesAvailableArgs{...}

type GetAvailablePrefixPrefixesAvailableOutput

type GetAvailablePrefixPrefixesAvailableOutput struct{ *pulumi.OutputState }

func (GetAvailablePrefixPrefixesAvailableOutput) ElementType

func (GetAvailablePrefixPrefixesAvailableOutput) Family

func (GetAvailablePrefixPrefixesAvailableOutput) Prefix

func (GetAvailablePrefixPrefixesAvailableOutput) ToGetAvailablePrefixPrefixesAvailableOutput

func (o GetAvailablePrefixPrefixesAvailableOutput) ToGetAvailablePrefixPrefixesAvailableOutput() GetAvailablePrefixPrefixesAvailableOutput

func (GetAvailablePrefixPrefixesAvailableOutput) ToGetAvailablePrefixPrefixesAvailableOutputWithContext

func (o GetAvailablePrefixPrefixesAvailableOutput) ToGetAvailablePrefixPrefixesAvailableOutputWithContext(ctx context.Context) GetAvailablePrefixPrefixesAvailableOutput

func (GetAvailablePrefixPrefixesAvailableOutput) VrfId

type GetIpAddressesArgs

type GetIpAddressesArgs struct {
	Filters []GetIpAddressesFilter `pulumi:"filters"`
	// Defaults to `1000`.
	Limit *int `pulumi:"limit"`
}

A collection of arguments for invoking getIpAddresses.

type GetIpAddressesFilter

type GetIpAddressesFilter struct {
	Name  string `pulumi:"name"`
	Value string `pulumi:"value"`
}

type GetIpAddressesFilterArgs

type GetIpAddressesFilterArgs struct {
	Name  pulumi.StringInput `pulumi:"name"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetIpAddressesFilterArgs) ElementType

func (GetIpAddressesFilterArgs) ElementType() reflect.Type

func (GetIpAddressesFilterArgs) ToGetIpAddressesFilterOutput

func (i GetIpAddressesFilterArgs) ToGetIpAddressesFilterOutput() GetIpAddressesFilterOutput

func (GetIpAddressesFilterArgs) ToGetIpAddressesFilterOutputWithContext

func (i GetIpAddressesFilterArgs) ToGetIpAddressesFilterOutputWithContext(ctx context.Context) GetIpAddressesFilterOutput

type GetIpAddressesFilterArray

type GetIpAddressesFilterArray []GetIpAddressesFilterInput

func (GetIpAddressesFilterArray) ElementType

func (GetIpAddressesFilterArray) ElementType() reflect.Type

func (GetIpAddressesFilterArray) ToGetIpAddressesFilterArrayOutput

func (i GetIpAddressesFilterArray) ToGetIpAddressesFilterArrayOutput() GetIpAddressesFilterArrayOutput

func (GetIpAddressesFilterArray) ToGetIpAddressesFilterArrayOutputWithContext

func (i GetIpAddressesFilterArray) ToGetIpAddressesFilterArrayOutputWithContext(ctx context.Context) GetIpAddressesFilterArrayOutput

type GetIpAddressesFilterArrayInput

type GetIpAddressesFilterArrayInput interface {
	pulumi.Input

	ToGetIpAddressesFilterArrayOutput() GetIpAddressesFilterArrayOutput
	ToGetIpAddressesFilterArrayOutputWithContext(context.Context) GetIpAddressesFilterArrayOutput
}

GetIpAddressesFilterArrayInput is an input type that accepts GetIpAddressesFilterArray and GetIpAddressesFilterArrayOutput values. You can construct a concrete instance of `GetIpAddressesFilterArrayInput` via:

GetIpAddressesFilterArray{ GetIpAddressesFilterArgs{...} }

type GetIpAddressesFilterArrayOutput

type GetIpAddressesFilterArrayOutput struct{ *pulumi.OutputState }

func (GetIpAddressesFilterArrayOutput) ElementType

func (GetIpAddressesFilterArrayOutput) Index

func (GetIpAddressesFilterArrayOutput) ToGetIpAddressesFilterArrayOutput

func (o GetIpAddressesFilterArrayOutput) ToGetIpAddressesFilterArrayOutput() GetIpAddressesFilterArrayOutput

func (GetIpAddressesFilterArrayOutput) ToGetIpAddressesFilterArrayOutputWithContext

func (o GetIpAddressesFilterArrayOutput) ToGetIpAddressesFilterArrayOutputWithContext(ctx context.Context) GetIpAddressesFilterArrayOutput

type GetIpAddressesFilterInput

type GetIpAddressesFilterInput interface {
	pulumi.Input

	ToGetIpAddressesFilterOutput() GetIpAddressesFilterOutput
	ToGetIpAddressesFilterOutputWithContext(context.Context) GetIpAddressesFilterOutput
}

GetIpAddressesFilterInput is an input type that accepts GetIpAddressesFilterArgs and GetIpAddressesFilterOutput values. You can construct a concrete instance of `GetIpAddressesFilterInput` via:

GetIpAddressesFilterArgs{...}

type GetIpAddressesFilterOutput

type GetIpAddressesFilterOutput struct{ *pulumi.OutputState }

func (GetIpAddressesFilterOutput) ElementType

func (GetIpAddressesFilterOutput) ElementType() reflect.Type

func (GetIpAddressesFilterOutput) Name

func (GetIpAddressesFilterOutput) ToGetIpAddressesFilterOutput

func (o GetIpAddressesFilterOutput) ToGetIpAddressesFilterOutput() GetIpAddressesFilterOutput

func (GetIpAddressesFilterOutput) ToGetIpAddressesFilterOutputWithContext

func (o GetIpAddressesFilterOutput) ToGetIpAddressesFilterOutputWithContext(ctx context.Context) GetIpAddressesFilterOutput

func (GetIpAddressesFilterOutput) Value

type GetIpAddressesIpAddress

type GetIpAddressesIpAddress struct {
	AddressFamily string                          `pulumi:"addressFamily"`
	Created       string                          `pulumi:"created"`
	CustomFields  map[string]string               `pulumi:"customFields"`
	Description   string                          `pulumi:"description"`
	DnsName       string                          `pulumi:"dnsName"`
	Id            int                             `pulumi:"id"`
	IpAddress     string                          `pulumi:"ipAddress"`
	LastUpdated   string                          `pulumi:"lastUpdated"`
	Role          string                          `pulumi:"role"`
	Status        string                          `pulumi:"status"`
	Tags          []GetIpAddressesIpAddressTag    `pulumi:"tags"`
	Tenants       []GetIpAddressesIpAddressTenant `pulumi:"tenants"`
}

type GetIpAddressesIpAddressArgs

type GetIpAddressesIpAddressArgs struct {
	AddressFamily pulumi.StringInput                      `pulumi:"addressFamily"`
	Created       pulumi.StringInput                      `pulumi:"created"`
	CustomFields  pulumi.StringMapInput                   `pulumi:"customFields"`
	Description   pulumi.StringInput                      `pulumi:"description"`
	DnsName       pulumi.StringInput                      `pulumi:"dnsName"`
	Id            pulumi.IntInput                         `pulumi:"id"`
	IpAddress     pulumi.StringInput                      `pulumi:"ipAddress"`
	LastUpdated   pulumi.StringInput                      `pulumi:"lastUpdated"`
	Role          pulumi.StringInput                      `pulumi:"role"`
	Status        pulumi.StringInput                      `pulumi:"status"`
	Tags          GetIpAddressesIpAddressTagArrayInput    `pulumi:"tags"`
	Tenants       GetIpAddressesIpAddressTenantArrayInput `pulumi:"tenants"`
}

func (GetIpAddressesIpAddressArgs) ElementType

func (GetIpAddressesIpAddressArgs) ToGetIpAddressesIpAddressOutput

func (i GetIpAddressesIpAddressArgs) ToGetIpAddressesIpAddressOutput() GetIpAddressesIpAddressOutput

func (GetIpAddressesIpAddressArgs) ToGetIpAddressesIpAddressOutputWithContext

func (i GetIpAddressesIpAddressArgs) ToGetIpAddressesIpAddressOutputWithContext(ctx context.Context) GetIpAddressesIpAddressOutput

type GetIpAddressesIpAddressArray

type GetIpAddressesIpAddressArray []GetIpAddressesIpAddressInput

func (GetIpAddressesIpAddressArray) ElementType

func (GetIpAddressesIpAddressArray) ToGetIpAddressesIpAddressArrayOutput

func (i GetIpAddressesIpAddressArray) ToGetIpAddressesIpAddressArrayOutput() GetIpAddressesIpAddressArrayOutput

func (GetIpAddressesIpAddressArray) ToGetIpAddressesIpAddressArrayOutputWithContext

func (i GetIpAddressesIpAddressArray) ToGetIpAddressesIpAddressArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressArrayOutput

type GetIpAddressesIpAddressArrayInput

type GetIpAddressesIpAddressArrayInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressArrayOutput() GetIpAddressesIpAddressArrayOutput
	ToGetIpAddressesIpAddressArrayOutputWithContext(context.Context) GetIpAddressesIpAddressArrayOutput
}

GetIpAddressesIpAddressArrayInput is an input type that accepts GetIpAddressesIpAddressArray and GetIpAddressesIpAddressArrayOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressArrayInput` via:

GetIpAddressesIpAddressArray{ GetIpAddressesIpAddressArgs{...} }

type GetIpAddressesIpAddressArrayOutput

type GetIpAddressesIpAddressArrayOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressArrayOutput) ElementType

func (GetIpAddressesIpAddressArrayOutput) Index

func (GetIpAddressesIpAddressArrayOutput) ToGetIpAddressesIpAddressArrayOutput

func (o GetIpAddressesIpAddressArrayOutput) ToGetIpAddressesIpAddressArrayOutput() GetIpAddressesIpAddressArrayOutput

func (GetIpAddressesIpAddressArrayOutput) ToGetIpAddressesIpAddressArrayOutputWithContext

func (o GetIpAddressesIpAddressArrayOutput) ToGetIpAddressesIpAddressArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressArrayOutput

type GetIpAddressesIpAddressInput

type GetIpAddressesIpAddressInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressOutput() GetIpAddressesIpAddressOutput
	ToGetIpAddressesIpAddressOutputWithContext(context.Context) GetIpAddressesIpAddressOutput
}

GetIpAddressesIpAddressInput is an input type that accepts GetIpAddressesIpAddressArgs and GetIpAddressesIpAddressOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressInput` via:

GetIpAddressesIpAddressArgs{...}

type GetIpAddressesIpAddressOutput

type GetIpAddressesIpAddressOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressOutput) AddressFamily

func (GetIpAddressesIpAddressOutput) Created

func (GetIpAddressesIpAddressOutput) CustomFields

func (GetIpAddressesIpAddressOutput) Description

func (GetIpAddressesIpAddressOutput) DnsName

func (GetIpAddressesIpAddressOutput) ElementType

func (GetIpAddressesIpAddressOutput) Id

func (GetIpAddressesIpAddressOutput) IpAddress

func (GetIpAddressesIpAddressOutput) LastUpdated

func (GetIpAddressesIpAddressOutput) Role

func (GetIpAddressesIpAddressOutput) Status

func (GetIpAddressesIpAddressOutput) Tags

func (GetIpAddressesIpAddressOutput) Tenants

func (GetIpAddressesIpAddressOutput) ToGetIpAddressesIpAddressOutput

func (o GetIpAddressesIpAddressOutput) ToGetIpAddressesIpAddressOutput() GetIpAddressesIpAddressOutput

func (GetIpAddressesIpAddressOutput) ToGetIpAddressesIpAddressOutputWithContext

func (o GetIpAddressesIpAddressOutput) ToGetIpAddressesIpAddressOutputWithContext(ctx context.Context) GetIpAddressesIpAddressOutput

type GetIpAddressesIpAddressTag

type GetIpAddressesIpAddressTag struct {
	Display string `pulumi:"display"`
	Id      int    `pulumi:"id"`
	Name    string `pulumi:"name"`
	Slug    string `pulumi:"slug"`
}

type GetIpAddressesIpAddressTagArgs

type GetIpAddressesIpAddressTagArgs struct {
	Display pulumi.StringInput `pulumi:"display"`
	Id      pulumi.IntInput    `pulumi:"id"`
	Name    pulumi.StringInput `pulumi:"name"`
	Slug    pulumi.StringInput `pulumi:"slug"`
}

func (GetIpAddressesIpAddressTagArgs) ElementType

func (GetIpAddressesIpAddressTagArgs) ToGetIpAddressesIpAddressTagOutput

func (i GetIpAddressesIpAddressTagArgs) ToGetIpAddressesIpAddressTagOutput() GetIpAddressesIpAddressTagOutput

func (GetIpAddressesIpAddressTagArgs) ToGetIpAddressesIpAddressTagOutputWithContext

func (i GetIpAddressesIpAddressTagArgs) ToGetIpAddressesIpAddressTagOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTagOutput

type GetIpAddressesIpAddressTagArray

type GetIpAddressesIpAddressTagArray []GetIpAddressesIpAddressTagInput

func (GetIpAddressesIpAddressTagArray) ElementType

func (GetIpAddressesIpAddressTagArray) ToGetIpAddressesIpAddressTagArrayOutput

func (i GetIpAddressesIpAddressTagArray) ToGetIpAddressesIpAddressTagArrayOutput() GetIpAddressesIpAddressTagArrayOutput

func (GetIpAddressesIpAddressTagArray) ToGetIpAddressesIpAddressTagArrayOutputWithContext

func (i GetIpAddressesIpAddressTagArray) ToGetIpAddressesIpAddressTagArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTagArrayOutput

type GetIpAddressesIpAddressTagArrayInput

type GetIpAddressesIpAddressTagArrayInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressTagArrayOutput() GetIpAddressesIpAddressTagArrayOutput
	ToGetIpAddressesIpAddressTagArrayOutputWithContext(context.Context) GetIpAddressesIpAddressTagArrayOutput
}

GetIpAddressesIpAddressTagArrayInput is an input type that accepts GetIpAddressesIpAddressTagArray and GetIpAddressesIpAddressTagArrayOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressTagArrayInput` via:

GetIpAddressesIpAddressTagArray{ GetIpAddressesIpAddressTagArgs{...} }

type GetIpAddressesIpAddressTagArrayOutput

type GetIpAddressesIpAddressTagArrayOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressTagArrayOutput) ElementType

func (GetIpAddressesIpAddressTagArrayOutput) Index

func (GetIpAddressesIpAddressTagArrayOutput) ToGetIpAddressesIpAddressTagArrayOutput

func (o GetIpAddressesIpAddressTagArrayOutput) ToGetIpAddressesIpAddressTagArrayOutput() GetIpAddressesIpAddressTagArrayOutput

func (GetIpAddressesIpAddressTagArrayOutput) ToGetIpAddressesIpAddressTagArrayOutputWithContext

func (o GetIpAddressesIpAddressTagArrayOutput) ToGetIpAddressesIpAddressTagArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTagArrayOutput

type GetIpAddressesIpAddressTagInput

type GetIpAddressesIpAddressTagInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressTagOutput() GetIpAddressesIpAddressTagOutput
	ToGetIpAddressesIpAddressTagOutputWithContext(context.Context) GetIpAddressesIpAddressTagOutput
}

GetIpAddressesIpAddressTagInput is an input type that accepts GetIpAddressesIpAddressTagArgs and GetIpAddressesIpAddressTagOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressTagInput` via:

GetIpAddressesIpAddressTagArgs{...}

type GetIpAddressesIpAddressTagOutput

type GetIpAddressesIpAddressTagOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressTagOutput) Display

func (GetIpAddressesIpAddressTagOutput) ElementType

func (GetIpAddressesIpAddressTagOutput) Id

func (GetIpAddressesIpAddressTagOutput) Name

func (GetIpAddressesIpAddressTagOutput) Slug

func (GetIpAddressesIpAddressTagOutput) ToGetIpAddressesIpAddressTagOutput

func (o GetIpAddressesIpAddressTagOutput) ToGetIpAddressesIpAddressTagOutput() GetIpAddressesIpAddressTagOutput

func (GetIpAddressesIpAddressTagOutput) ToGetIpAddressesIpAddressTagOutputWithContext

func (o GetIpAddressesIpAddressTagOutput) ToGetIpAddressesIpAddressTagOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTagOutput

type GetIpAddressesIpAddressTenant

type GetIpAddressesIpAddressTenant struct {
	Id   int    `pulumi:"id"`
	Name string `pulumi:"name"`
	Slug string `pulumi:"slug"`
}

type GetIpAddressesIpAddressTenantArgs

type GetIpAddressesIpAddressTenantArgs struct {
	Id   pulumi.IntInput    `pulumi:"id"`
	Name pulumi.StringInput `pulumi:"name"`
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetIpAddressesIpAddressTenantArgs) ElementType

func (GetIpAddressesIpAddressTenantArgs) ToGetIpAddressesIpAddressTenantOutput

func (i GetIpAddressesIpAddressTenantArgs) ToGetIpAddressesIpAddressTenantOutput() GetIpAddressesIpAddressTenantOutput

func (GetIpAddressesIpAddressTenantArgs) ToGetIpAddressesIpAddressTenantOutputWithContext

func (i GetIpAddressesIpAddressTenantArgs) ToGetIpAddressesIpAddressTenantOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTenantOutput

type GetIpAddressesIpAddressTenantArray

type GetIpAddressesIpAddressTenantArray []GetIpAddressesIpAddressTenantInput

func (GetIpAddressesIpAddressTenantArray) ElementType

func (GetIpAddressesIpAddressTenantArray) ToGetIpAddressesIpAddressTenantArrayOutput

func (i GetIpAddressesIpAddressTenantArray) ToGetIpAddressesIpAddressTenantArrayOutput() GetIpAddressesIpAddressTenantArrayOutput

func (GetIpAddressesIpAddressTenantArray) ToGetIpAddressesIpAddressTenantArrayOutputWithContext

func (i GetIpAddressesIpAddressTenantArray) ToGetIpAddressesIpAddressTenantArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTenantArrayOutput

type GetIpAddressesIpAddressTenantArrayInput

type GetIpAddressesIpAddressTenantArrayInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressTenantArrayOutput() GetIpAddressesIpAddressTenantArrayOutput
	ToGetIpAddressesIpAddressTenantArrayOutputWithContext(context.Context) GetIpAddressesIpAddressTenantArrayOutput
}

GetIpAddressesIpAddressTenantArrayInput is an input type that accepts GetIpAddressesIpAddressTenantArray and GetIpAddressesIpAddressTenantArrayOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressTenantArrayInput` via:

GetIpAddressesIpAddressTenantArray{ GetIpAddressesIpAddressTenantArgs{...} }

type GetIpAddressesIpAddressTenantArrayOutput

type GetIpAddressesIpAddressTenantArrayOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressTenantArrayOutput) ElementType

func (GetIpAddressesIpAddressTenantArrayOutput) Index

func (GetIpAddressesIpAddressTenantArrayOutput) ToGetIpAddressesIpAddressTenantArrayOutput

func (o GetIpAddressesIpAddressTenantArrayOutput) ToGetIpAddressesIpAddressTenantArrayOutput() GetIpAddressesIpAddressTenantArrayOutput

func (GetIpAddressesIpAddressTenantArrayOutput) ToGetIpAddressesIpAddressTenantArrayOutputWithContext

func (o GetIpAddressesIpAddressTenantArrayOutput) ToGetIpAddressesIpAddressTenantArrayOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTenantArrayOutput

type GetIpAddressesIpAddressTenantInput

type GetIpAddressesIpAddressTenantInput interface {
	pulumi.Input

	ToGetIpAddressesIpAddressTenantOutput() GetIpAddressesIpAddressTenantOutput
	ToGetIpAddressesIpAddressTenantOutputWithContext(context.Context) GetIpAddressesIpAddressTenantOutput
}

GetIpAddressesIpAddressTenantInput is an input type that accepts GetIpAddressesIpAddressTenantArgs and GetIpAddressesIpAddressTenantOutput values. You can construct a concrete instance of `GetIpAddressesIpAddressTenantInput` via:

GetIpAddressesIpAddressTenantArgs{...}

type GetIpAddressesIpAddressTenantOutput

type GetIpAddressesIpAddressTenantOutput struct{ *pulumi.OutputState }

func (GetIpAddressesIpAddressTenantOutput) ElementType

func (GetIpAddressesIpAddressTenantOutput) Id

func (GetIpAddressesIpAddressTenantOutput) Name

func (GetIpAddressesIpAddressTenantOutput) Slug

func (GetIpAddressesIpAddressTenantOutput) ToGetIpAddressesIpAddressTenantOutput

func (o GetIpAddressesIpAddressTenantOutput) ToGetIpAddressesIpAddressTenantOutput() GetIpAddressesIpAddressTenantOutput

func (GetIpAddressesIpAddressTenantOutput) ToGetIpAddressesIpAddressTenantOutputWithContext

func (o GetIpAddressesIpAddressTenantOutput) ToGetIpAddressesIpAddressTenantOutputWithContext(ctx context.Context) GetIpAddressesIpAddressTenantOutput

type GetIpAddressesOutputArgs

type GetIpAddressesOutputArgs struct {
	Filters GetIpAddressesFilterArrayInput `pulumi:"filters"`
	// Defaults to `1000`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getIpAddresses.

func (GetIpAddressesOutputArgs) ElementType

func (GetIpAddressesOutputArgs) ElementType() reflect.Type

type GetIpAddressesResult

type GetIpAddressesResult struct {
	Filters []GetIpAddressesFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id          string                    `pulumi:"id"`
	IpAddresses []GetIpAddressesIpAddress `pulumi:"ipAddresses"`
	// Defaults to `1000`.
	Limit *int `pulumi:"limit"`
}

A collection of values returned by getIpAddresses.

func GetIpAddresses

func GetIpAddresses(ctx *pulumi.Context, args *GetIpAddressesArgs, opts ...pulumi.InvokeOption) (*GetIpAddressesResult, error)

type GetIpAddressesResultOutput

type GetIpAddressesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getIpAddresses.

func (GetIpAddressesResultOutput) ElementType

func (GetIpAddressesResultOutput) ElementType() reflect.Type

func (GetIpAddressesResultOutput) Filters

func (GetIpAddressesResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetIpAddressesResultOutput) IpAddresses

func (GetIpAddressesResultOutput) Limit

Defaults to `1000`.

func (GetIpAddressesResultOutput) ToGetIpAddressesResultOutput

func (o GetIpAddressesResultOutput) ToGetIpAddressesResultOutput() GetIpAddressesResultOutput

func (GetIpAddressesResultOutput) ToGetIpAddressesResultOutputWithContext

func (o GetIpAddressesResultOutput) ToGetIpAddressesResultOutputWithContext(ctx context.Context) GetIpAddressesResultOutput

type GetPrefixesArgs

type GetPrefixesArgs struct {
	// A list of filters to apply to the API query when requesting prefixes.
	Filters []GetPrefixesFilter `pulumi:"filters"`
	// The limit of objects to return from the API lookup. Defaults to `0`.
	Limit *int `pulumi:"limit"`
}

A collection of arguments for invoking getPrefixes.

type GetPrefixesFilter

type GetPrefixesFilter struct {
	// The name of the field to filter on. Supported fields are: `prefix`, `contains`, `vlanVid`, `vrfId`, `vlanId`, `status`, `tenantId`, `siteId`, & `tag`.
	Name string `pulumi:"name"`
	// The value to pass to the specified filter.
	Value string `pulumi:"value"`
}

type GetPrefixesFilterArgs

type GetPrefixesFilterArgs struct {
	// The name of the field to filter on. Supported fields are: `prefix`, `contains`, `vlanVid`, `vrfId`, `vlanId`, `status`, `tenantId`, `siteId`, & `tag`.
	Name pulumi.StringInput `pulumi:"name"`
	// The value to pass to the specified filter.
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetPrefixesFilterArgs) ElementType

func (GetPrefixesFilterArgs) ElementType() reflect.Type

func (GetPrefixesFilterArgs) ToGetPrefixesFilterOutput

func (i GetPrefixesFilterArgs) ToGetPrefixesFilterOutput() GetPrefixesFilterOutput

func (GetPrefixesFilterArgs) ToGetPrefixesFilterOutputWithContext

func (i GetPrefixesFilterArgs) ToGetPrefixesFilterOutputWithContext(ctx context.Context) GetPrefixesFilterOutput

type GetPrefixesFilterArray

type GetPrefixesFilterArray []GetPrefixesFilterInput

func (GetPrefixesFilterArray) ElementType

func (GetPrefixesFilterArray) ElementType() reflect.Type

func (GetPrefixesFilterArray) ToGetPrefixesFilterArrayOutput

func (i GetPrefixesFilterArray) ToGetPrefixesFilterArrayOutput() GetPrefixesFilterArrayOutput

func (GetPrefixesFilterArray) ToGetPrefixesFilterArrayOutputWithContext

func (i GetPrefixesFilterArray) ToGetPrefixesFilterArrayOutputWithContext(ctx context.Context) GetPrefixesFilterArrayOutput

type GetPrefixesFilterArrayInput

type GetPrefixesFilterArrayInput interface {
	pulumi.Input

	ToGetPrefixesFilterArrayOutput() GetPrefixesFilterArrayOutput
	ToGetPrefixesFilterArrayOutputWithContext(context.Context) GetPrefixesFilterArrayOutput
}

GetPrefixesFilterArrayInput is an input type that accepts GetPrefixesFilterArray and GetPrefixesFilterArrayOutput values. You can construct a concrete instance of `GetPrefixesFilterArrayInput` via:

GetPrefixesFilterArray{ GetPrefixesFilterArgs{...} }

type GetPrefixesFilterArrayOutput

type GetPrefixesFilterArrayOutput struct{ *pulumi.OutputState }

func (GetPrefixesFilterArrayOutput) ElementType

func (GetPrefixesFilterArrayOutput) Index

func (GetPrefixesFilterArrayOutput) ToGetPrefixesFilterArrayOutput

func (o GetPrefixesFilterArrayOutput) ToGetPrefixesFilterArrayOutput() GetPrefixesFilterArrayOutput

func (GetPrefixesFilterArrayOutput) ToGetPrefixesFilterArrayOutputWithContext

func (o GetPrefixesFilterArrayOutput) ToGetPrefixesFilterArrayOutputWithContext(ctx context.Context) GetPrefixesFilterArrayOutput

type GetPrefixesFilterInput

type GetPrefixesFilterInput interface {
	pulumi.Input

	ToGetPrefixesFilterOutput() GetPrefixesFilterOutput
	ToGetPrefixesFilterOutputWithContext(context.Context) GetPrefixesFilterOutput
}

GetPrefixesFilterInput is an input type that accepts GetPrefixesFilterArgs and GetPrefixesFilterOutput values. You can construct a concrete instance of `GetPrefixesFilterInput` via:

GetPrefixesFilterArgs{...}

type GetPrefixesFilterOutput

type GetPrefixesFilterOutput struct{ *pulumi.OutputState }

func (GetPrefixesFilterOutput) ElementType

func (GetPrefixesFilterOutput) ElementType() reflect.Type

func (GetPrefixesFilterOutput) Name

The name of the field to filter on. Supported fields are: `prefix`, `contains`, `vlanVid`, `vrfId`, `vlanId`, `status`, `tenantId`, `siteId`, & `tag`.

func (GetPrefixesFilterOutput) ToGetPrefixesFilterOutput

func (o GetPrefixesFilterOutput) ToGetPrefixesFilterOutput() GetPrefixesFilterOutput

func (GetPrefixesFilterOutput) ToGetPrefixesFilterOutputWithContext

func (o GetPrefixesFilterOutput) ToGetPrefixesFilterOutputWithContext(ctx context.Context) GetPrefixesFilterOutput

func (GetPrefixesFilterOutput) Value

The value to pass to the specified filter.

type GetPrefixesOutputArgs

type GetPrefixesOutputArgs struct {
	// A list of filters to apply to the API query when requesting prefixes.
	Filters GetPrefixesFilterArrayInput `pulumi:"filters"`
	// The limit of objects to return from the API lookup. Defaults to `0`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getPrefixes.

func (GetPrefixesOutputArgs) ElementType

func (GetPrefixesOutputArgs) ElementType() reflect.Type

type GetPrefixesPrefix

type GetPrefixesPrefix struct {
	Description string   `pulumi:"description"`
	Id          int      `pulumi:"id"`
	LocationId  int      `pulumi:"locationId"`
	Prefix      string   `pulumi:"prefix"`
	RegionId    int      `pulumi:"regionId"`
	SiteGroupId int      `pulumi:"siteGroupId"`
	SiteId      int      `pulumi:"siteId"`
	Status      string   `pulumi:"status"`
	Tags        []string `pulumi:"tags"`
	TenantId    int      `pulumi:"tenantId"`
	VlanId      int      `pulumi:"vlanId"`
	VlanVid     float64  `pulumi:"vlanVid"`
	VrfId       int      `pulumi:"vrfId"`
}

type GetPrefixesPrefixArgs

type GetPrefixesPrefixArgs struct {
	Description pulumi.StringInput      `pulumi:"description"`
	Id          pulumi.IntInput         `pulumi:"id"`
	LocationId  pulumi.IntInput         `pulumi:"locationId"`
	Prefix      pulumi.StringInput      `pulumi:"prefix"`
	RegionId    pulumi.IntInput         `pulumi:"regionId"`
	SiteGroupId pulumi.IntInput         `pulumi:"siteGroupId"`
	SiteId      pulumi.IntInput         `pulumi:"siteId"`
	Status      pulumi.StringInput      `pulumi:"status"`
	Tags        pulumi.StringArrayInput `pulumi:"tags"`
	TenantId    pulumi.IntInput         `pulumi:"tenantId"`
	VlanId      pulumi.IntInput         `pulumi:"vlanId"`
	VlanVid     pulumi.Float64Input     `pulumi:"vlanVid"`
	VrfId       pulumi.IntInput         `pulumi:"vrfId"`
}

func (GetPrefixesPrefixArgs) ElementType

func (GetPrefixesPrefixArgs) ElementType() reflect.Type

func (GetPrefixesPrefixArgs) ToGetPrefixesPrefixOutput

func (i GetPrefixesPrefixArgs) ToGetPrefixesPrefixOutput() GetPrefixesPrefixOutput

func (GetPrefixesPrefixArgs) ToGetPrefixesPrefixOutputWithContext

func (i GetPrefixesPrefixArgs) ToGetPrefixesPrefixOutputWithContext(ctx context.Context) GetPrefixesPrefixOutput

type GetPrefixesPrefixArray

type GetPrefixesPrefixArray []GetPrefixesPrefixInput

func (GetPrefixesPrefixArray) ElementType

func (GetPrefixesPrefixArray) ElementType() reflect.Type

func (GetPrefixesPrefixArray) ToGetPrefixesPrefixArrayOutput

func (i GetPrefixesPrefixArray) ToGetPrefixesPrefixArrayOutput() GetPrefixesPrefixArrayOutput

func (GetPrefixesPrefixArray) ToGetPrefixesPrefixArrayOutputWithContext

func (i GetPrefixesPrefixArray) ToGetPrefixesPrefixArrayOutputWithContext(ctx context.Context) GetPrefixesPrefixArrayOutput

type GetPrefixesPrefixArrayInput

type GetPrefixesPrefixArrayInput interface {
	pulumi.Input

	ToGetPrefixesPrefixArrayOutput() GetPrefixesPrefixArrayOutput
	ToGetPrefixesPrefixArrayOutputWithContext(context.Context) GetPrefixesPrefixArrayOutput
}

GetPrefixesPrefixArrayInput is an input type that accepts GetPrefixesPrefixArray and GetPrefixesPrefixArrayOutput values. You can construct a concrete instance of `GetPrefixesPrefixArrayInput` via:

GetPrefixesPrefixArray{ GetPrefixesPrefixArgs{...} }

type GetPrefixesPrefixArrayOutput

type GetPrefixesPrefixArrayOutput struct{ *pulumi.OutputState }

func (GetPrefixesPrefixArrayOutput) ElementType

func (GetPrefixesPrefixArrayOutput) Index

func (GetPrefixesPrefixArrayOutput) ToGetPrefixesPrefixArrayOutput

func (o GetPrefixesPrefixArrayOutput) ToGetPrefixesPrefixArrayOutput() GetPrefixesPrefixArrayOutput

func (GetPrefixesPrefixArrayOutput) ToGetPrefixesPrefixArrayOutputWithContext

func (o GetPrefixesPrefixArrayOutput) ToGetPrefixesPrefixArrayOutputWithContext(ctx context.Context) GetPrefixesPrefixArrayOutput

type GetPrefixesPrefixInput

type GetPrefixesPrefixInput interface {
	pulumi.Input

	ToGetPrefixesPrefixOutput() GetPrefixesPrefixOutput
	ToGetPrefixesPrefixOutputWithContext(context.Context) GetPrefixesPrefixOutput
}

GetPrefixesPrefixInput is an input type that accepts GetPrefixesPrefixArgs and GetPrefixesPrefixOutput values. You can construct a concrete instance of `GetPrefixesPrefixInput` via:

GetPrefixesPrefixArgs{...}

type GetPrefixesPrefixOutput

type GetPrefixesPrefixOutput struct{ *pulumi.OutputState }

func (GetPrefixesPrefixOutput) Description

func (GetPrefixesPrefixOutput) ElementType

func (GetPrefixesPrefixOutput) ElementType() reflect.Type

func (GetPrefixesPrefixOutput) Id

func (GetPrefixesPrefixOutput) LocationId

func (o GetPrefixesPrefixOutput) LocationId() pulumi.IntOutput

func (GetPrefixesPrefixOutput) Prefix

func (GetPrefixesPrefixOutput) RegionId

func (GetPrefixesPrefixOutput) SiteGroupId

func (o GetPrefixesPrefixOutput) SiteGroupId() pulumi.IntOutput

func (GetPrefixesPrefixOutput) SiteId

func (GetPrefixesPrefixOutput) Status

func (GetPrefixesPrefixOutput) Tags

func (GetPrefixesPrefixOutput) TenantId

func (GetPrefixesPrefixOutput) ToGetPrefixesPrefixOutput

func (o GetPrefixesPrefixOutput) ToGetPrefixesPrefixOutput() GetPrefixesPrefixOutput

func (GetPrefixesPrefixOutput) ToGetPrefixesPrefixOutputWithContext

func (o GetPrefixesPrefixOutput) ToGetPrefixesPrefixOutputWithContext(ctx context.Context) GetPrefixesPrefixOutput

func (GetPrefixesPrefixOutput) VlanId

func (GetPrefixesPrefixOutput) VlanVid

func (GetPrefixesPrefixOutput) VrfId

type GetPrefixesResult

type GetPrefixesResult struct {
	// A list of filters to apply to the API query when requesting prefixes.
	Filters []GetPrefixesFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The limit of objects to return from the API lookup. Defaults to `0`.
	Limit    *int                `pulumi:"limit"`
	Prefixes []GetPrefixesPrefix `pulumi:"prefixes"`
}

A collection of values returned by getPrefixes.

func GetPrefixes

func GetPrefixes(ctx *pulumi.Context, args *GetPrefixesArgs, opts ...pulumi.InvokeOption) (*GetPrefixesResult, error)

type GetPrefixesResultOutput

type GetPrefixesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPrefixes.

func (GetPrefixesResultOutput) ElementType

func (GetPrefixesResultOutput) ElementType() reflect.Type

func (GetPrefixesResultOutput) Filters

A list of filters to apply to the API query when requesting prefixes.

func (GetPrefixesResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetPrefixesResultOutput) Limit

The limit of objects to return from the API lookup. Defaults to `0`.

func (GetPrefixesResultOutput) Prefixes

func (GetPrefixesResultOutput) ToGetPrefixesResultOutput

func (o GetPrefixesResultOutput) ToGetPrefixesResultOutput() GetPrefixesResultOutput

func (GetPrefixesResultOutput) ToGetPrefixesResultOutputWithContext

func (o GetPrefixesResultOutput) ToGetPrefixesResultOutputWithContext(ctx context.Context) GetPrefixesResultOutput

type GetVlansArgs

type GetVlansArgs struct {
	Filters []GetVlansFilter `pulumi:"filters"`
	// Defaults to `0`.
	Limit *int `pulumi:"limit"`
}

A collection of arguments for invoking getVlans.

type GetVlansFilter

type GetVlansFilter struct {
	Name  string `pulumi:"name"`
	Value string `pulumi:"value"`
}

type GetVlansFilterArgs

type GetVlansFilterArgs struct {
	Name  pulumi.StringInput `pulumi:"name"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetVlansFilterArgs) ElementType

func (GetVlansFilterArgs) ElementType() reflect.Type

func (GetVlansFilterArgs) ToGetVlansFilterOutput

func (i GetVlansFilterArgs) ToGetVlansFilterOutput() GetVlansFilterOutput

func (GetVlansFilterArgs) ToGetVlansFilterOutputWithContext

func (i GetVlansFilterArgs) ToGetVlansFilterOutputWithContext(ctx context.Context) GetVlansFilterOutput

type GetVlansFilterArray

type GetVlansFilterArray []GetVlansFilterInput

func (GetVlansFilterArray) ElementType

func (GetVlansFilterArray) ElementType() reflect.Type

func (GetVlansFilterArray) ToGetVlansFilterArrayOutput

func (i GetVlansFilterArray) ToGetVlansFilterArrayOutput() GetVlansFilterArrayOutput

func (GetVlansFilterArray) ToGetVlansFilterArrayOutputWithContext

func (i GetVlansFilterArray) ToGetVlansFilterArrayOutputWithContext(ctx context.Context) GetVlansFilterArrayOutput

type GetVlansFilterArrayInput

type GetVlansFilterArrayInput interface {
	pulumi.Input

	ToGetVlansFilterArrayOutput() GetVlansFilterArrayOutput
	ToGetVlansFilterArrayOutputWithContext(context.Context) GetVlansFilterArrayOutput
}

GetVlansFilterArrayInput is an input type that accepts GetVlansFilterArray and GetVlansFilterArrayOutput values. You can construct a concrete instance of `GetVlansFilterArrayInput` via:

GetVlansFilterArray{ GetVlansFilterArgs{...} }

type GetVlansFilterArrayOutput

type GetVlansFilterArrayOutput struct{ *pulumi.OutputState }

func (GetVlansFilterArrayOutput) ElementType

func (GetVlansFilterArrayOutput) ElementType() reflect.Type

func (GetVlansFilterArrayOutput) Index

func (GetVlansFilterArrayOutput) ToGetVlansFilterArrayOutput

func (o GetVlansFilterArrayOutput) ToGetVlansFilterArrayOutput() GetVlansFilterArrayOutput

func (GetVlansFilterArrayOutput) ToGetVlansFilterArrayOutputWithContext

func (o GetVlansFilterArrayOutput) ToGetVlansFilterArrayOutputWithContext(ctx context.Context) GetVlansFilterArrayOutput

type GetVlansFilterInput

type GetVlansFilterInput interface {
	pulumi.Input

	ToGetVlansFilterOutput() GetVlansFilterOutput
	ToGetVlansFilterOutputWithContext(context.Context) GetVlansFilterOutput
}

GetVlansFilterInput is an input type that accepts GetVlansFilterArgs and GetVlansFilterOutput values. You can construct a concrete instance of `GetVlansFilterInput` via:

GetVlansFilterArgs{...}

type GetVlansFilterOutput

type GetVlansFilterOutput struct{ *pulumi.OutputState }

func (GetVlansFilterOutput) ElementType

func (GetVlansFilterOutput) ElementType() reflect.Type

func (GetVlansFilterOutput) Name

func (GetVlansFilterOutput) ToGetVlansFilterOutput

func (o GetVlansFilterOutput) ToGetVlansFilterOutput() GetVlansFilterOutput

func (GetVlansFilterOutput) ToGetVlansFilterOutputWithContext

func (o GetVlansFilterOutput) ToGetVlansFilterOutputWithContext(ctx context.Context) GetVlansFilterOutput

func (GetVlansFilterOutput) Value

type GetVlansOutputArgs

type GetVlansOutputArgs struct {
	Filters GetVlansFilterArrayInput `pulumi:"filters"`
	// Defaults to `0`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getVlans.

func (GetVlansOutputArgs) ElementType

func (GetVlansOutputArgs) ElementType() reflect.Type

type GetVlansResult

type GetVlansResult struct {
	Filters []GetVlansFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Defaults to `0`.
	Limit *int           `pulumi:"limit"`
	Vlans []GetVlansVlan `pulumi:"vlans"`
}

A collection of values returned by getVlans.

func GetVlans

func GetVlans(ctx *pulumi.Context, args *GetVlansArgs, opts ...pulumi.InvokeOption) (*GetVlansResult, error)

type GetVlansResultOutput

type GetVlansResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVlans.

func (GetVlansResultOutput) ElementType

func (GetVlansResultOutput) ElementType() reflect.Type

func (GetVlansResultOutput) Filters

func (GetVlansResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetVlansResultOutput) Limit

Defaults to `0`.

func (GetVlansResultOutput) ToGetVlansResultOutput

func (o GetVlansResultOutput) ToGetVlansResultOutput() GetVlansResultOutput

func (GetVlansResultOutput) ToGetVlansResultOutputWithContext

func (o GetVlansResultOutput) ToGetVlansResultOutputWithContext(ctx context.Context) GetVlansResultOutput

func (GetVlansResultOutput) Vlans

type GetVlansVlan

type GetVlansVlan struct {
	Description string `pulumi:"description"`
	GroupId     int    `pulumi:"groupId"`
	Name        string `pulumi:"name"`
	Role        int    `pulumi:"role"`
	Site        int    `pulumi:"site"`
	Status      string `pulumi:"status"`
	TagIds      []int  `pulumi:"tagIds"`
	Tenant      int    `pulumi:"tenant"`
	Vid         int    `pulumi:"vid"`
}

type GetVlansVlanArgs

type GetVlansVlanArgs struct {
	Description pulumi.StringInput   `pulumi:"description"`
	GroupId     pulumi.IntInput      `pulumi:"groupId"`
	Name        pulumi.StringInput   `pulumi:"name"`
	Role        pulumi.IntInput      `pulumi:"role"`
	Site        pulumi.IntInput      `pulumi:"site"`
	Status      pulumi.StringInput   `pulumi:"status"`
	TagIds      pulumi.IntArrayInput `pulumi:"tagIds"`
	Tenant      pulumi.IntInput      `pulumi:"tenant"`
	Vid         pulumi.IntInput      `pulumi:"vid"`
}

func (GetVlansVlanArgs) ElementType

func (GetVlansVlanArgs) ElementType() reflect.Type

func (GetVlansVlanArgs) ToGetVlansVlanOutput

func (i GetVlansVlanArgs) ToGetVlansVlanOutput() GetVlansVlanOutput

func (GetVlansVlanArgs) ToGetVlansVlanOutputWithContext

func (i GetVlansVlanArgs) ToGetVlansVlanOutputWithContext(ctx context.Context) GetVlansVlanOutput

type GetVlansVlanArray

type GetVlansVlanArray []GetVlansVlanInput

func (GetVlansVlanArray) ElementType

func (GetVlansVlanArray) ElementType() reflect.Type

func (GetVlansVlanArray) ToGetVlansVlanArrayOutput

func (i GetVlansVlanArray) ToGetVlansVlanArrayOutput() GetVlansVlanArrayOutput

func (GetVlansVlanArray) ToGetVlansVlanArrayOutputWithContext

func (i GetVlansVlanArray) ToGetVlansVlanArrayOutputWithContext(ctx context.Context) GetVlansVlanArrayOutput

type GetVlansVlanArrayInput

type GetVlansVlanArrayInput interface {
	pulumi.Input

	ToGetVlansVlanArrayOutput() GetVlansVlanArrayOutput
	ToGetVlansVlanArrayOutputWithContext(context.Context) GetVlansVlanArrayOutput
}

GetVlansVlanArrayInput is an input type that accepts GetVlansVlanArray and GetVlansVlanArrayOutput values. You can construct a concrete instance of `GetVlansVlanArrayInput` via:

GetVlansVlanArray{ GetVlansVlanArgs{...} }

type GetVlansVlanArrayOutput

type GetVlansVlanArrayOutput struct{ *pulumi.OutputState }

func (GetVlansVlanArrayOutput) ElementType

func (GetVlansVlanArrayOutput) ElementType() reflect.Type

func (GetVlansVlanArrayOutput) Index

func (GetVlansVlanArrayOutput) ToGetVlansVlanArrayOutput

func (o GetVlansVlanArrayOutput) ToGetVlansVlanArrayOutput() GetVlansVlanArrayOutput

func (GetVlansVlanArrayOutput) ToGetVlansVlanArrayOutputWithContext

func (o GetVlansVlanArrayOutput) ToGetVlansVlanArrayOutputWithContext(ctx context.Context) GetVlansVlanArrayOutput

type GetVlansVlanInput

type GetVlansVlanInput interface {
	pulumi.Input

	ToGetVlansVlanOutput() GetVlansVlanOutput
	ToGetVlansVlanOutputWithContext(context.Context) GetVlansVlanOutput
}

GetVlansVlanInput is an input type that accepts GetVlansVlanArgs and GetVlansVlanOutput values. You can construct a concrete instance of `GetVlansVlanInput` via:

GetVlansVlanArgs{...}

type GetVlansVlanOutput

type GetVlansVlanOutput struct{ *pulumi.OutputState }

func (GetVlansVlanOutput) Description

func (o GetVlansVlanOutput) Description() pulumi.StringOutput

func (GetVlansVlanOutput) ElementType

func (GetVlansVlanOutput) ElementType() reflect.Type

func (GetVlansVlanOutput) GroupId

func (o GetVlansVlanOutput) GroupId() pulumi.IntOutput

func (GetVlansVlanOutput) Name

func (GetVlansVlanOutput) Role

func (GetVlansVlanOutput) Site

func (GetVlansVlanOutput) Status

func (GetVlansVlanOutput) TagIds

func (GetVlansVlanOutput) Tenant

func (o GetVlansVlanOutput) Tenant() pulumi.IntOutput

func (GetVlansVlanOutput) ToGetVlansVlanOutput

func (o GetVlansVlanOutput) ToGetVlansVlanOutput() GetVlansVlanOutput

func (GetVlansVlanOutput) ToGetVlansVlanOutputWithContext

func (o GetVlansVlanOutput) ToGetVlansVlanOutputWithContext(ctx context.Context) GetVlansVlanOutput

func (GetVlansVlanOutput) Vid

type GetVrfsArgs

type GetVrfsArgs struct {
	Filters []GetVrfsFilter `pulumi:"filters"`
	// Defaults to `0`.
	Limit *int `pulumi:"limit"`
}

A collection of arguments for invoking getVrfs.

type GetVrfsFilter

type GetVrfsFilter struct {
	Name  string `pulumi:"name"`
	Value string `pulumi:"value"`
}

type GetVrfsFilterArgs

type GetVrfsFilterArgs struct {
	Name  pulumi.StringInput `pulumi:"name"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (GetVrfsFilterArgs) ElementType

func (GetVrfsFilterArgs) ElementType() reflect.Type

func (GetVrfsFilterArgs) ToGetVrfsFilterOutput

func (i GetVrfsFilterArgs) ToGetVrfsFilterOutput() GetVrfsFilterOutput

func (GetVrfsFilterArgs) ToGetVrfsFilterOutputWithContext

func (i GetVrfsFilterArgs) ToGetVrfsFilterOutputWithContext(ctx context.Context) GetVrfsFilterOutput

type GetVrfsFilterArray

type GetVrfsFilterArray []GetVrfsFilterInput

func (GetVrfsFilterArray) ElementType

func (GetVrfsFilterArray) ElementType() reflect.Type

func (GetVrfsFilterArray) ToGetVrfsFilterArrayOutput

func (i GetVrfsFilterArray) ToGetVrfsFilterArrayOutput() GetVrfsFilterArrayOutput

func (GetVrfsFilterArray) ToGetVrfsFilterArrayOutputWithContext

func (i GetVrfsFilterArray) ToGetVrfsFilterArrayOutputWithContext(ctx context.Context) GetVrfsFilterArrayOutput

type GetVrfsFilterArrayInput

type GetVrfsFilterArrayInput interface {
	pulumi.Input

	ToGetVrfsFilterArrayOutput() GetVrfsFilterArrayOutput
	ToGetVrfsFilterArrayOutputWithContext(context.Context) GetVrfsFilterArrayOutput
}

GetVrfsFilterArrayInput is an input type that accepts GetVrfsFilterArray and GetVrfsFilterArrayOutput values. You can construct a concrete instance of `GetVrfsFilterArrayInput` via:

GetVrfsFilterArray{ GetVrfsFilterArgs{...} }

type GetVrfsFilterArrayOutput

type GetVrfsFilterArrayOutput struct{ *pulumi.OutputState }

func (GetVrfsFilterArrayOutput) ElementType

func (GetVrfsFilterArrayOutput) ElementType() reflect.Type

func (GetVrfsFilterArrayOutput) Index

func (GetVrfsFilterArrayOutput) ToGetVrfsFilterArrayOutput

func (o GetVrfsFilterArrayOutput) ToGetVrfsFilterArrayOutput() GetVrfsFilterArrayOutput

func (GetVrfsFilterArrayOutput) ToGetVrfsFilterArrayOutputWithContext

func (o GetVrfsFilterArrayOutput) ToGetVrfsFilterArrayOutputWithContext(ctx context.Context) GetVrfsFilterArrayOutput

type GetVrfsFilterInput

type GetVrfsFilterInput interface {
	pulumi.Input

	ToGetVrfsFilterOutput() GetVrfsFilterOutput
	ToGetVrfsFilterOutputWithContext(context.Context) GetVrfsFilterOutput
}

GetVrfsFilterInput is an input type that accepts GetVrfsFilterArgs and GetVrfsFilterOutput values. You can construct a concrete instance of `GetVrfsFilterInput` via:

GetVrfsFilterArgs{...}

type GetVrfsFilterOutput

type GetVrfsFilterOutput struct{ *pulumi.OutputState }

func (GetVrfsFilterOutput) ElementType

func (GetVrfsFilterOutput) ElementType() reflect.Type

func (GetVrfsFilterOutput) Name

func (GetVrfsFilterOutput) ToGetVrfsFilterOutput

func (o GetVrfsFilterOutput) ToGetVrfsFilterOutput() GetVrfsFilterOutput

func (GetVrfsFilterOutput) ToGetVrfsFilterOutputWithContext

func (o GetVrfsFilterOutput) ToGetVrfsFilterOutputWithContext(ctx context.Context) GetVrfsFilterOutput

func (GetVrfsFilterOutput) Value

type GetVrfsOutputArgs

type GetVrfsOutputArgs struct {
	Filters GetVrfsFilterArrayInput `pulumi:"filters"`
	// Defaults to `0`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getVrfs.

func (GetVrfsOutputArgs) ElementType

func (GetVrfsOutputArgs) ElementType() reflect.Type

type GetVrfsResult

type GetVrfsResult struct {
	Filters []GetVrfsFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Defaults to `0`.
	Limit *int         `pulumi:"limit"`
	Vrfs  []GetVrfsVrf `pulumi:"vrfs"`
}

A collection of values returned by getVrfs.

func GetVrfs

func GetVrfs(ctx *pulumi.Context, args *GetVrfsArgs, opts ...pulumi.InvokeOption) (*GetVrfsResult, error)

type GetVrfsResultOutput

type GetVrfsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVrfs.

func (GetVrfsResultOutput) ElementType

func (GetVrfsResultOutput) ElementType() reflect.Type

func (GetVrfsResultOutput) Filters

func (GetVrfsResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetVrfsResultOutput) Limit

Defaults to `0`.

func (GetVrfsResultOutput) ToGetVrfsResultOutput

func (o GetVrfsResultOutput) ToGetVrfsResultOutput() GetVrfsResultOutput

func (GetVrfsResultOutput) ToGetVrfsResultOutputWithContext

func (o GetVrfsResultOutput) ToGetVrfsResultOutputWithContext(ctx context.Context) GetVrfsResultOutput

func (GetVrfsResultOutput) Vrfs

type GetVrfsVrf

type GetVrfsVrf struct {
	Description string `pulumi:"description"`
	Id          int    `pulumi:"id"`
	Name        string `pulumi:"name"`
	Rd          string `pulumi:"rd"`
	Tenant      int    `pulumi:"tenant"`
}

type GetVrfsVrfArgs

type GetVrfsVrfArgs struct {
	Description pulumi.StringInput `pulumi:"description"`
	Id          pulumi.IntInput    `pulumi:"id"`
	Name        pulumi.StringInput `pulumi:"name"`
	Rd          pulumi.StringInput `pulumi:"rd"`
	Tenant      pulumi.IntInput    `pulumi:"tenant"`
}

func (GetVrfsVrfArgs) ElementType

func (GetVrfsVrfArgs) ElementType() reflect.Type

func (GetVrfsVrfArgs) ToGetVrfsVrfOutput

func (i GetVrfsVrfArgs) ToGetVrfsVrfOutput() GetVrfsVrfOutput

func (GetVrfsVrfArgs) ToGetVrfsVrfOutputWithContext

func (i GetVrfsVrfArgs) ToGetVrfsVrfOutputWithContext(ctx context.Context) GetVrfsVrfOutput

type GetVrfsVrfArray

type GetVrfsVrfArray []GetVrfsVrfInput

func (GetVrfsVrfArray) ElementType

func (GetVrfsVrfArray) ElementType() reflect.Type

func (GetVrfsVrfArray) ToGetVrfsVrfArrayOutput

func (i GetVrfsVrfArray) ToGetVrfsVrfArrayOutput() GetVrfsVrfArrayOutput

func (GetVrfsVrfArray) ToGetVrfsVrfArrayOutputWithContext

func (i GetVrfsVrfArray) ToGetVrfsVrfArrayOutputWithContext(ctx context.Context) GetVrfsVrfArrayOutput

type GetVrfsVrfArrayInput

type GetVrfsVrfArrayInput interface {
	pulumi.Input

	ToGetVrfsVrfArrayOutput() GetVrfsVrfArrayOutput
	ToGetVrfsVrfArrayOutputWithContext(context.Context) GetVrfsVrfArrayOutput
}

GetVrfsVrfArrayInput is an input type that accepts GetVrfsVrfArray and GetVrfsVrfArrayOutput values. You can construct a concrete instance of `GetVrfsVrfArrayInput` via:

GetVrfsVrfArray{ GetVrfsVrfArgs{...} }

type GetVrfsVrfArrayOutput

type GetVrfsVrfArrayOutput struct{ *pulumi.OutputState }

func (GetVrfsVrfArrayOutput) ElementType

func (GetVrfsVrfArrayOutput) ElementType() reflect.Type

func (GetVrfsVrfArrayOutput) Index

func (GetVrfsVrfArrayOutput) ToGetVrfsVrfArrayOutput

func (o GetVrfsVrfArrayOutput) ToGetVrfsVrfArrayOutput() GetVrfsVrfArrayOutput

func (GetVrfsVrfArrayOutput) ToGetVrfsVrfArrayOutputWithContext

func (o GetVrfsVrfArrayOutput) ToGetVrfsVrfArrayOutputWithContext(ctx context.Context) GetVrfsVrfArrayOutput

type GetVrfsVrfInput

type GetVrfsVrfInput interface {
	pulumi.Input

	ToGetVrfsVrfOutput() GetVrfsVrfOutput
	ToGetVrfsVrfOutputWithContext(context.Context) GetVrfsVrfOutput
}

GetVrfsVrfInput is an input type that accepts GetVrfsVrfArgs and GetVrfsVrfOutput values. You can construct a concrete instance of `GetVrfsVrfInput` via:

GetVrfsVrfArgs{...}

type GetVrfsVrfOutput

type GetVrfsVrfOutput struct{ *pulumi.OutputState }

func (GetVrfsVrfOutput) Description

func (o GetVrfsVrfOutput) Description() pulumi.StringOutput

func (GetVrfsVrfOutput) ElementType

func (GetVrfsVrfOutput) ElementType() reflect.Type

func (GetVrfsVrfOutput) Id

func (GetVrfsVrfOutput) Name

func (GetVrfsVrfOutput) Rd

func (GetVrfsVrfOutput) Tenant

func (o GetVrfsVrfOutput) Tenant() pulumi.IntOutput

func (GetVrfsVrfOutput) ToGetVrfsVrfOutput

func (o GetVrfsVrfOutput) ToGetVrfsVrfOutput() GetVrfsVrfOutput

func (GetVrfsVrfOutput) ToGetVrfsVrfOutputWithContext

func (o GetVrfsVrfOutput) ToGetVrfsVrfOutputWithContext(ctx context.Context) GetVrfsVrfOutput

type IpAddress

type IpAddress struct {
	pulumi.CustomResourceState

	CustomFields pulumi.StringMapOutput `pulumi:"customFields"`
	Description  pulumi.StringPtrOutput `pulumi:"description"`
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrOutput    `pulumi:"deviceInterfaceId"`
	DnsName           pulumi.StringPtrOutput `pulumi:"dnsName"`
	// Required when `objectType` is set.
	InterfaceId         pulumi.IntPtrOutput                   `pulumi:"interfaceId"`
	IpAddress           pulumi.StringOutput                   `pulumi:"ipAddress"`
	NatInsideAddressId  pulumi.IntPtrOutput                   `pulumi:"natInsideAddressId"`
	NatOutsideAddresses IpAddressNatOutsideAddressArrayOutput `pulumi:"natOutsideAddresses"`
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrOutput `pulumi:"objectType"`
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrOutput `pulumi:"role"`
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`.
	Status   pulumi.StringOutput      `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrOutput `pulumi:"virtualMachineInterfaceId"`
	VrfId                     pulumi.IntPtrOutput `pulumi:"vrfId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#ip-addresses):

> An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world. > > Like a prefix, an IP address can optionally be assigned to a VRF (otherwise, it will appear in the "global" table). IP addresses are automatically arranged under parent prefixes within their respective VRFs according to the IP hierarchy.

## Example Usage

### Creating an IP address that is assigned to a virtual machine interface

Starting with provider version 3.5.0, you can use the `virtualMachineInterfaceId` attribute to assign an IP address to a virtual machine interface. You can also use the `interfaceId` and `objectType` attributes instead.

With `virtualMachineInterfaceId`: ```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/virt"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Assuming a virtual machine with the id `123` exists
		this, err := virt.NewInterface(ctx, "this", &virt.InterfaceArgs{
			Name:             pulumi.String("eth0"),
			VirtualMachineId: pulumi.Int(123),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewIpAddress(ctx, "this", &ipam.IpAddressArgs{
			IpAddress:                 pulumi.String("10.0.0.60/24"),
			Status:                    pulumi.String("active"),
			VirtualMachineInterfaceId: this.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

With `objectType` and `interfaceId`: ```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/virt"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Assuming a virtual machine with the id `123` exists
		this, err := virt.NewInterface(ctx, "this", &virt.InterfaceArgs{
			Name:             pulumi.String("eth0"),
			VirtualMachineId: pulumi.Int(123),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewIpAddress(ctx, "this", &ipam.IpAddressArgs{
			IpAddress:   pulumi.String("10.0.0.60/24"),
			Status:      pulumi.String("active"),
			InterfaceId: this.ID(),
			ObjectType:  pulumi.String("virtualization.vminterface"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Creating an IP address that is assigned to a device interface

Starting with provider version 3.5.0, you can use the `deviceInterfaceId` attribute to assign an IP address to a device interface. You can also use the `interfaceId` and `objectType` attributes instead.

With `deviceInterfaceId`: ```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/dcim"
"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Assuming a device with the id `123` exists
		this, err := dcim.NewDeviceInterface(ctx, "this", &dcim.DeviceInterfaceArgs{
			Name:     pulumi.String("eth0"),
			DeviceId: pulumi.Int(123),
			Type:     pulumi.String("1000base-t"),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewIpAddress(ctx, "this", &ipam.IpAddressArgs{
			IpAddress:         pulumi.String("10.0.0.60/24"),
			Status:            pulumi.String("active"),
			DeviceInterfaceId: this.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

With `objectType` and `interfaceId`: ```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/dcim"
"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Assuming a device with the id `123` exists
		this, err := dcim.NewDeviceInterface(ctx, "this", &dcim.DeviceInterfaceArgs{
			Name:     pulumi.String("eth0"),
			DeviceId: pulumi.Int(123),
			Type:     pulumi.String("1000base-t"),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewIpAddress(ctx, "this", &ipam.IpAddressArgs{
			IpAddress:   pulumi.String("10.0.0.60/24"),
			Status:      pulumi.String("active"),
			InterfaceId: this.ID(),
			ObjectType:  pulumi.String("dcim.interface"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Creating an IP address that is not assigned to anything

You can create an IP address that is not assigned to anything by omitting the attributes mentioned above.

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewIpAddress(ctx, "this", &ipam.IpAddressArgs{
			IpAddress: pulumi.String("10.0.0.50/24"),
			Status:    pulumi.String("reserved"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetIpAddress

func GetIpAddress(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IpAddressState, opts ...pulumi.ResourceOption) (*IpAddress, error)

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).

func NewIpAddress

func NewIpAddress(ctx *pulumi.Context,
	name string, args *IpAddressArgs, opts ...pulumi.ResourceOption) (*IpAddress, error)

NewIpAddress registers a new resource with the given unique name, arguments, and options.

func (*IpAddress) ElementType

func (*IpAddress) ElementType() reflect.Type

func (*IpAddress) ToIpAddressOutput

func (i *IpAddress) ToIpAddressOutput() IpAddressOutput

func (*IpAddress) ToIpAddressOutputWithContext

func (i *IpAddress) ToIpAddressOutputWithContext(ctx context.Context) IpAddressOutput

type IpAddressArgs

type IpAddressArgs struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrInput
	DnsName           pulumi.StringPtrInput
	// Required when `objectType` is set.
	InterfaceId        pulumi.IntPtrInput
	IpAddress          pulumi.StringInput
	NatInsideAddressId pulumi.IntPtrInput
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrInput
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrInput
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`.
	Status   pulumi.StringInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrInput
	VrfId                     pulumi.IntPtrInput
}

The set of arguments for constructing a IpAddress resource.

func (IpAddressArgs) ElementType

func (IpAddressArgs) ElementType() reflect.Type

type IpAddressArray

type IpAddressArray []IpAddressInput

func (IpAddressArray) ElementType

func (IpAddressArray) ElementType() reflect.Type

func (IpAddressArray) ToIpAddressArrayOutput

func (i IpAddressArray) ToIpAddressArrayOutput() IpAddressArrayOutput

func (IpAddressArray) ToIpAddressArrayOutputWithContext

func (i IpAddressArray) ToIpAddressArrayOutputWithContext(ctx context.Context) IpAddressArrayOutput

type IpAddressArrayInput

type IpAddressArrayInput interface {
	pulumi.Input

	ToIpAddressArrayOutput() IpAddressArrayOutput
	ToIpAddressArrayOutputWithContext(context.Context) IpAddressArrayOutput
}

IpAddressArrayInput is an input type that accepts IpAddressArray and IpAddressArrayOutput values. You can construct a concrete instance of `IpAddressArrayInput` via:

IpAddressArray{ IpAddressArgs{...} }

type IpAddressArrayOutput

type IpAddressArrayOutput struct{ *pulumi.OutputState }

func (IpAddressArrayOutput) ElementType

func (IpAddressArrayOutput) ElementType() reflect.Type

func (IpAddressArrayOutput) Index

func (IpAddressArrayOutput) ToIpAddressArrayOutput

func (o IpAddressArrayOutput) ToIpAddressArrayOutput() IpAddressArrayOutput

func (IpAddressArrayOutput) ToIpAddressArrayOutputWithContext

func (o IpAddressArrayOutput) ToIpAddressArrayOutputWithContext(ctx context.Context) IpAddressArrayOutput

type IpAddressInput

type IpAddressInput interface {
	pulumi.Input

	ToIpAddressOutput() IpAddressOutput
	ToIpAddressOutputWithContext(ctx context.Context) IpAddressOutput
}

type IpAddressMap

type IpAddressMap map[string]IpAddressInput

func (IpAddressMap) ElementType

func (IpAddressMap) ElementType() reflect.Type

func (IpAddressMap) ToIpAddressMapOutput

func (i IpAddressMap) ToIpAddressMapOutput() IpAddressMapOutput

func (IpAddressMap) ToIpAddressMapOutputWithContext

func (i IpAddressMap) ToIpAddressMapOutputWithContext(ctx context.Context) IpAddressMapOutput

type IpAddressMapInput

type IpAddressMapInput interface {
	pulumi.Input

	ToIpAddressMapOutput() IpAddressMapOutput
	ToIpAddressMapOutputWithContext(context.Context) IpAddressMapOutput
}

IpAddressMapInput is an input type that accepts IpAddressMap and IpAddressMapOutput values. You can construct a concrete instance of `IpAddressMapInput` via:

IpAddressMap{ "key": IpAddressArgs{...} }

type IpAddressMapOutput

type IpAddressMapOutput struct{ *pulumi.OutputState }

func (IpAddressMapOutput) ElementType

func (IpAddressMapOutput) ElementType() reflect.Type

func (IpAddressMapOutput) MapIndex

func (IpAddressMapOutput) ToIpAddressMapOutput

func (o IpAddressMapOutput) ToIpAddressMapOutput() IpAddressMapOutput

func (IpAddressMapOutput) ToIpAddressMapOutputWithContext

func (o IpAddressMapOutput) ToIpAddressMapOutputWithContext(ctx context.Context) IpAddressMapOutput

type IpAddressNatOutsideAddress

type IpAddressNatOutsideAddress struct {
	AddressFamily *int    `pulumi:"addressFamily"`
	Id            *int    `pulumi:"id"`
	IpAddress     *string `pulumi:"ipAddress"`
}

type IpAddressNatOutsideAddressArgs

type IpAddressNatOutsideAddressArgs struct {
	AddressFamily pulumi.IntPtrInput    `pulumi:"addressFamily"`
	Id            pulumi.IntPtrInput    `pulumi:"id"`
	IpAddress     pulumi.StringPtrInput `pulumi:"ipAddress"`
}

func (IpAddressNatOutsideAddressArgs) ElementType

func (IpAddressNatOutsideAddressArgs) ToIpAddressNatOutsideAddressOutput

func (i IpAddressNatOutsideAddressArgs) ToIpAddressNatOutsideAddressOutput() IpAddressNatOutsideAddressOutput

func (IpAddressNatOutsideAddressArgs) ToIpAddressNatOutsideAddressOutputWithContext

func (i IpAddressNatOutsideAddressArgs) ToIpAddressNatOutsideAddressOutputWithContext(ctx context.Context) IpAddressNatOutsideAddressOutput

type IpAddressNatOutsideAddressArray

type IpAddressNatOutsideAddressArray []IpAddressNatOutsideAddressInput

func (IpAddressNatOutsideAddressArray) ElementType

func (IpAddressNatOutsideAddressArray) ToIpAddressNatOutsideAddressArrayOutput

func (i IpAddressNatOutsideAddressArray) ToIpAddressNatOutsideAddressArrayOutput() IpAddressNatOutsideAddressArrayOutput

func (IpAddressNatOutsideAddressArray) ToIpAddressNatOutsideAddressArrayOutputWithContext

func (i IpAddressNatOutsideAddressArray) ToIpAddressNatOutsideAddressArrayOutputWithContext(ctx context.Context) IpAddressNatOutsideAddressArrayOutput

type IpAddressNatOutsideAddressArrayInput

type IpAddressNatOutsideAddressArrayInput interface {
	pulumi.Input

	ToIpAddressNatOutsideAddressArrayOutput() IpAddressNatOutsideAddressArrayOutput
	ToIpAddressNatOutsideAddressArrayOutputWithContext(context.Context) IpAddressNatOutsideAddressArrayOutput
}

IpAddressNatOutsideAddressArrayInput is an input type that accepts IpAddressNatOutsideAddressArray and IpAddressNatOutsideAddressArrayOutput values. You can construct a concrete instance of `IpAddressNatOutsideAddressArrayInput` via:

IpAddressNatOutsideAddressArray{ IpAddressNatOutsideAddressArgs{...} }

type IpAddressNatOutsideAddressArrayOutput

type IpAddressNatOutsideAddressArrayOutput struct{ *pulumi.OutputState }

func (IpAddressNatOutsideAddressArrayOutput) ElementType

func (IpAddressNatOutsideAddressArrayOutput) Index

func (IpAddressNatOutsideAddressArrayOutput) ToIpAddressNatOutsideAddressArrayOutput

func (o IpAddressNatOutsideAddressArrayOutput) ToIpAddressNatOutsideAddressArrayOutput() IpAddressNatOutsideAddressArrayOutput

func (IpAddressNatOutsideAddressArrayOutput) ToIpAddressNatOutsideAddressArrayOutputWithContext

func (o IpAddressNatOutsideAddressArrayOutput) ToIpAddressNatOutsideAddressArrayOutputWithContext(ctx context.Context) IpAddressNatOutsideAddressArrayOutput

type IpAddressNatOutsideAddressInput

type IpAddressNatOutsideAddressInput interface {
	pulumi.Input

	ToIpAddressNatOutsideAddressOutput() IpAddressNatOutsideAddressOutput
	ToIpAddressNatOutsideAddressOutputWithContext(context.Context) IpAddressNatOutsideAddressOutput
}

IpAddressNatOutsideAddressInput is an input type that accepts IpAddressNatOutsideAddressArgs and IpAddressNatOutsideAddressOutput values. You can construct a concrete instance of `IpAddressNatOutsideAddressInput` via:

IpAddressNatOutsideAddressArgs{...}

type IpAddressNatOutsideAddressOutput

type IpAddressNatOutsideAddressOutput struct{ *pulumi.OutputState }

func (IpAddressNatOutsideAddressOutput) AddressFamily

func (IpAddressNatOutsideAddressOutput) ElementType

func (IpAddressNatOutsideAddressOutput) Id

func (IpAddressNatOutsideAddressOutput) IpAddress

func (IpAddressNatOutsideAddressOutput) ToIpAddressNatOutsideAddressOutput

func (o IpAddressNatOutsideAddressOutput) ToIpAddressNatOutsideAddressOutput() IpAddressNatOutsideAddressOutput

func (IpAddressNatOutsideAddressOutput) ToIpAddressNatOutsideAddressOutputWithContext

func (o IpAddressNatOutsideAddressOutput) ToIpAddressNatOutsideAddressOutputWithContext(ctx context.Context) IpAddressNatOutsideAddressOutput

type IpAddressOutput

type IpAddressOutput struct{ *pulumi.OutputState }

func (IpAddressOutput) CustomFields

func (o IpAddressOutput) CustomFields() pulumi.StringMapOutput

func (IpAddressOutput) Description

func (o IpAddressOutput) Description() pulumi.StringPtrOutput

func (IpAddressOutput) DeviceInterfaceId

func (o IpAddressOutput) DeviceInterfaceId() pulumi.IntPtrOutput

Conflicts with `interfaceId` and `virtualMachineInterfaceId`.

func (IpAddressOutput) DnsName

func (IpAddressOutput) ElementType

func (IpAddressOutput) ElementType() reflect.Type

func (IpAddressOutput) InterfaceId

func (o IpAddressOutput) InterfaceId() pulumi.IntPtrOutput

Required when `objectType` is set.

func (IpAddressOutput) IpAddress

func (o IpAddressOutput) IpAddress() pulumi.StringOutput

func (IpAddressOutput) NatInsideAddressId

func (o IpAddressOutput) NatInsideAddressId() pulumi.IntPtrOutput

func (IpAddressOutput) NatOutsideAddresses

func (IpAddressOutput) ObjectType

func (o IpAddressOutput) ObjectType() pulumi.StringPtrOutput

Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.

func (IpAddressOutput) Role

Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.

func (IpAddressOutput) Status

func (o IpAddressOutput) Status() pulumi.StringOutput

Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`.

func (IpAddressOutput) Tags

func (IpAddressOutput) TagsAlls

func (IpAddressOutput) TenantId

func (o IpAddressOutput) TenantId() pulumi.IntPtrOutput

func (IpAddressOutput) ToIpAddressOutput

func (o IpAddressOutput) ToIpAddressOutput() IpAddressOutput

func (IpAddressOutput) ToIpAddressOutputWithContext

func (o IpAddressOutput) ToIpAddressOutputWithContext(ctx context.Context) IpAddressOutput

func (IpAddressOutput) VirtualMachineInterfaceId

func (o IpAddressOutput) VirtualMachineInterfaceId() pulumi.IntPtrOutput

Conflicts with `interfaceId` and `deviceInterfaceId`.

func (IpAddressOutput) VrfId

type IpAddressState

type IpAddressState struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	// Conflicts with `interfaceId` and `virtualMachineInterfaceId`.
	DeviceInterfaceId pulumi.IntPtrInput
	DnsName           pulumi.StringPtrInput
	// Required when `objectType` is set.
	InterfaceId         pulumi.IntPtrInput
	IpAddress           pulumi.StringPtrInput
	NatInsideAddressId  pulumi.IntPtrInput
	NatOutsideAddresses IpAddressNatOutsideAddressArrayInput
	// Valid values are `virtualization.vminterface` and `dcim.interface`. Required when `interfaceId` is set.
	ObjectType pulumi.StringPtrInput
	// Valid values are `loopback`, `secondary`, `anycast`, `vip`, `vrrp`, `hsrp`, `glbp` and `carp`.
	Role pulumi.StringPtrInput
	// Valid values are `active`, `reserved`, `deprecated`, `dhcp` and `slaac`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	// Conflicts with `interfaceId` and `deviceInterfaceId`.
	VirtualMachineInterfaceId pulumi.IntPtrInput
	VrfId                     pulumi.IntPtrInput
}

func (IpAddressState) ElementType

func (IpAddressState) ElementType() reflect.Type

type IpRange

type IpRange struct {
	pulumi.CustomResourceState

	Description  pulumi.StringPtrOutput `pulumi:"description"`
	EndAddress   pulumi.StringOutput    `pulumi:"endAddress"`
	RoleId       pulumi.IntPtrOutput    `pulumi:"roleId"`
	StartAddress pulumi.StringOutput    `pulumi:"startAddress"`
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrOutput   `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	VrfId    pulumi.IntPtrOutput      `pulumi:"vrfId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#ip-ranges):

> This model represents an arbitrary range of individual IPv4 or IPv6 addresses, inclusive of its starting and ending addresses. For instance, the range 192.0.2.10 to 192.0.2.20 has eleven members. (The total member count is available as the size property on an IPRange instance.) Like prefixes and IP addresses, each IP range may optionally be assigned to a VRF and/or tenant.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewIpRange(ctx, "cust_a_prod", &ipam.IpRangeArgs{
			StartAddress: pulumi.String("10.0.0.1/24"),
			EndAddress:   pulumi.String("10.0.0.50/24"),
			Tags: pulumi.StringArray{
				pulumi.String("customer-a"),
				pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetIpRange

func GetIpRange(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IpRangeState, opts ...pulumi.ResourceOption) (*IpRange, error)

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).

func NewIpRange

func NewIpRange(ctx *pulumi.Context,
	name string, args *IpRangeArgs, opts ...pulumi.ResourceOption) (*IpRange, error)

NewIpRange registers a new resource with the given unique name, arguments, and options.

func (*IpRange) ElementType

func (*IpRange) ElementType() reflect.Type

func (*IpRange) ToIpRangeOutput

func (i *IpRange) ToIpRangeOutput() IpRangeOutput

func (*IpRange) ToIpRangeOutputWithContext

func (i *IpRange) ToIpRangeOutputWithContext(ctx context.Context) IpRangeOutput

type IpRangeArgs

type IpRangeArgs struct {
	Description  pulumi.StringPtrInput
	EndAddress   pulumi.StringInput
	RoleId       pulumi.IntPtrInput
	StartAddress pulumi.StringInput
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

The set of arguments for constructing a IpRange resource.

func (IpRangeArgs) ElementType

func (IpRangeArgs) ElementType() reflect.Type

type IpRangeArray

type IpRangeArray []IpRangeInput

func (IpRangeArray) ElementType

func (IpRangeArray) ElementType() reflect.Type

func (IpRangeArray) ToIpRangeArrayOutput

func (i IpRangeArray) ToIpRangeArrayOutput() IpRangeArrayOutput

func (IpRangeArray) ToIpRangeArrayOutputWithContext

func (i IpRangeArray) ToIpRangeArrayOutputWithContext(ctx context.Context) IpRangeArrayOutput

type IpRangeArrayInput

type IpRangeArrayInput interface {
	pulumi.Input

	ToIpRangeArrayOutput() IpRangeArrayOutput
	ToIpRangeArrayOutputWithContext(context.Context) IpRangeArrayOutput
}

IpRangeArrayInput is an input type that accepts IpRangeArray and IpRangeArrayOutput values. You can construct a concrete instance of `IpRangeArrayInput` via:

IpRangeArray{ IpRangeArgs{...} }

type IpRangeArrayOutput

type IpRangeArrayOutput struct{ *pulumi.OutputState }

func (IpRangeArrayOutput) ElementType

func (IpRangeArrayOutput) ElementType() reflect.Type

func (IpRangeArrayOutput) Index

func (IpRangeArrayOutput) ToIpRangeArrayOutput

func (o IpRangeArrayOutput) ToIpRangeArrayOutput() IpRangeArrayOutput

func (IpRangeArrayOutput) ToIpRangeArrayOutputWithContext

func (o IpRangeArrayOutput) ToIpRangeArrayOutputWithContext(ctx context.Context) IpRangeArrayOutput

type IpRangeInput

type IpRangeInput interface {
	pulumi.Input

	ToIpRangeOutput() IpRangeOutput
	ToIpRangeOutputWithContext(ctx context.Context) IpRangeOutput
}

type IpRangeMap

type IpRangeMap map[string]IpRangeInput

func (IpRangeMap) ElementType

func (IpRangeMap) ElementType() reflect.Type

func (IpRangeMap) ToIpRangeMapOutput

func (i IpRangeMap) ToIpRangeMapOutput() IpRangeMapOutput

func (IpRangeMap) ToIpRangeMapOutputWithContext

func (i IpRangeMap) ToIpRangeMapOutputWithContext(ctx context.Context) IpRangeMapOutput

type IpRangeMapInput

type IpRangeMapInput interface {
	pulumi.Input

	ToIpRangeMapOutput() IpRangeMapOutput
	ToIpRangeMapOutputWithContext(context.Context) IpRangeMapOutput
}

IpRangeMapInput is an input type that accepts IpRangeMap and IpRangeMapOutput values. You can construct a concrete instance of `IpRangeMapInput` via:

IpRangeMap{ "key": IpRangeArgs{...} }

type IpRangeMapOutput

type IpRangeMapOutput struct{ *pulumi.OutputState }

func (IpRangeMapOutput) ElementType

func (IpRangeMapOutput) ElementType() reflect.Type

func (IpRangeMapOutput) MapIndex

func (IpRangeMapOutput) ToIpRangeMapOutput

func (o IpRangeMapOutput) ToIpRangeMapOutput() IpRangeMapOutput

func (IpRangeMapOutput) ToIpRangeMapOutputWithContext

func (o IpRangeMapOutput) ToIpRangeMapOutputWithContext(ctx context.Context) IpRangeMapOutput

type IpRangeOutput

type IpRangeOutput struct{ *pulumi.OutputState }

func (IpRangeOutput) Description

func (o IpRangeOutput) Description() pulumi.StringPtrOutput

func (IpRangeOutput) ElementType

func (IpRangeOutput) ElementType() reflect.Type

func (IpRangeOutput) EndAddress

func (o IpRangeOutput) EndAddress() pulumi.StringOutput

func (IpRangeOutput) RoleId

func (o IpRangeOutput) RoleId() pulumi.IntPtrOutput

func (IpRangeOutput) StartAddress

func (o IpRangeOutput) StartAddress() pulumi.StringOutput

func (IpRangeOutput) Status

Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.

func (IpRangeOutput) Tags

func (IpRangeOutput) TagsAlls

func (o IpRangeOutput) TagsAlls() pulumi.StringArrayOutput

func (IpRangeOutput) TenantId

func (o IpRangeOutput) TenantId() pulumi.IntPtrOutput

func (IpRangeOutput) ToIpRangeOutput

func (o IpRangeOutput) ToIpRangeOutput() IpRangeOutput

func (IpRangeOutput) ToIpRangeOutputWithContext

func (o IpRangeOutput) ToIpRangeOutputWithContext(ctx context.Context) IpRangeOutput

func (IpRangeOutput) VrfId

func (o IpRangeOutput) VrfId() pulumi.IntPtrOutput

type IpRangeState

type IpRangeState struct {
	Description  pulumi.StringPtrInput
	EndAddress   pulumi.StringPtrInput
	RoleId       pulumi.IntPtrInput
	StartAddress pulumi.StringPtrInput
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

func (IpRangeState) ElementType

func (IpRangeState) ElementType() reflect.Type

type LookupAsnArgs

type LookupAsnArgs struct {
	// At least one of `asn` or `tag` must be given.
	Asn *string `pulumi:"asn"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `asn` or `tag` must be given.
	Tag *string `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN *string `pulumi:"tagN"`
}

A collection of arguments for invoking getAsn.

type LookupAsnOutputArgs

type LookupAsnOutputArgs struct {
	// At least one of `asn` or `tag` must be given.
	Asn pulumi.StringPtrInput `pulumi:"asn"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `asn` or `tag` must be given.
	Tag pulumi.StringPtrInput `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN pulumi.StringPtrInput `pulumi:"tagN"`
}

A collection of arguments for invoking getAsn.

func (LookupAsnOutputArgs) ElementType

func (LookupAsnOutputArgs) ElementType() reflect.Type

type LookupAsnResult

type LookupAsnResult struct {
	// At least one of `asn` or `tag` must be given.
	Asn         *string `pulumi:"asn"`
	Description string  `pulumi:"description"`
	// The ID of this resource.
	Id int `pulumi:"id"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `asn` or `tag` must be given.
	Tag *string `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN *string  `pulumi:"tagN"`
	Tags []string `pulumi:"tags"`
}

A collection of values returned by getAsn.

func LookupAsn

func LookupAsn(ctx *pulumi.Context, args *LookupAsnArgs, opts ...pulumi.InvokeOption) (*LookupAsnResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.LookupAsn(ctx, &ipam.LookupAsnArgs{
			Asn: pulumi.StringRef("1111"),
			Tag: pulumi.StringRef("tag-1"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ipam.LookupAsn(ctx, &ipam.LookupAsnArgs{
			Tag:  pulumi.StringRef("tag-1"),
			TagN: pulumi.StringRef("tag-2"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupAsnResultOutput

type LookupAsnResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAsn.

func (LookupAsnResultOutput) Asn

At least one of `asn` or `tag` must be given.

func (LookupAsnResultOutput) Description

func (o LookupAsnResultOutput) Description() pulumi.StringOutput

func (LookupAsnResultOutput) ElementType

func (LookupAsnResultOutput) ElementType() reflect.Type

func (LookupAsnResultOutput) Id

The ID of this resource.

func (LookupAsnResultOutput) Tag

Tag to include in the data source filter (must match the tag's slug). At least one of `asn` or `tag` must be given.

func (LookupAsnResultOutput) TagN

Tag to exclude from the data source filter (must match the tag's slug). Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions) for more information on available lookup expressions.

func (LookupAsnResultOutput) Tags

func (LookupAsnResultOutput) ToLookupAsnResultOutput

func (o LookupAsnResultOutput) ToLookupAsnResultOutput() LookupAsnResultOutput

func (LookupAsnResultOutput) ToLookupAsnResultOutputWithContext

func (o LookupAsnResultOutput) ToLookupAsnResultOutputWithContext(ctx context.Context) LookupAsnResultOutput

type LookupAvailablePrefixArgs

type LookupAvailablePrefixArgs struct {
	PrefixId int `pulumi:"prefixId"`
}

A collection of arguments for invoking getAvailablePrefix.

type LookupAvailablePrefixOutputArgs

type LookupAvailablePrefixOutputArgs struct {
	PrefixId pulumi.IntInput `pulumi:"prefixId"`
}

A collection of arguments for invoking getAvailablePrefix.

func (LookupAvailablePrefixOutputArgs) ElementType

type LookupAvailablePrefixResult

type LookupAvailablePrefixResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id                 string                                `pulumi:"id"`
	PrefixId           int                                   `pulumi:"prefixId"`
	PrefixesAvailables []GetAvailablePrefixPrefixesAvailable `pulumi:"prefixesAvailables"`
}

A collection of values returned by getAvailablePrefix.

type LookupAvailablePrefixResultOutput

type LookupAvailablePrefixResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAvailablePrefix.

func (LookupAvailablePrefixResultOutput) ElementType

func (LookupAvailablePrefixResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupAvailablePrefixResultOutput) PrefixId

func (LookupAvailablePrefixResultOutput) PrefixesAvailables

func (LookupAvailablePrefixResultOutput) ToLookupAvailablePrefixResultOutput

func (o LookupAvailablePrefixResultOutput) ToLookupAvailablePrefixResultOutput() LookupAvailablePrefixResultOutput

func (LookupAvailablePrefixResultOutput) ToLookupAvailablePrefixResultOutputWithContext

func (o LookupAvailablePrefixResultOutput) ToLookupAvailablePrefixResultOutputWithContext(ctx context.Context) LookupAvailablePrefixResultOutput

type LookupIpRangeArgs

type LookupIpRangeArgs struct {
	Contains string `pulumi:"contains"`
}

A collection of arguments for invoking getIpRange.

type LookupIpRangeOutputArgs

type LookupIpRangeOutputArgs struct {
	Contains pulumi.StringInput `pulumi:"contains"`
}

A collection of arguments for invoking getIpRange.

func (LookupIpRangeOutputArgs) ElementType

func (LookupIpRangeOutputArgs) ElementType() reflect.Type

type LookupIpRangeResult

type LookupIpRangeResult struct {
	Contains string `pulumi:"contains"`
	// The ID of this resource.
	Id int `pulumi:"id"`
}

A collection of values returned by getIpRange.

func LookupIpRange

func LookupIpRange(ctx *pulumi.Context, args *LookupIpRangeArgs, opts ...pulumi.InvokeOption) (*LookupIpRangeResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.LookupIpRange(ctx, &ipam.LookupIpRangeArgs{
			Contains: "10.0.0.1/24",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupIpRangeResultOutput

type LookupIpRangeResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getIpRange.

func (LookupIpRangeResultOutput) Contains

func (LookupIpRangeResultOutput) ElementType

func (LookupIpRangeResultOutput) ElementType() reflect.Type

func (LookupIpRangeResultOutput) Id

The ID of this resource.

func (LookupIpRangeResultOutput) ToLookupIpRangeResultOutput

func (o LookupIpRangeResultOutput) ToLookupIpRangeResultOutput() LookupIpRangeResultOutput

func (LookupIpRangeResultOutput) ToLookupIpRangeResultOutputWithContext

func (o LookupIpRangeResultOutput) ToLookupIpRangeResultOutputWithContext(ctx context.Context) LookupIpRangeResultOutput

type LookupPrefixArgs

type LookupPrefixArgs struct {
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `prefix`.
	//
	// Deprecated: The `cidr` parameter is deprecated in favor of the canonical `prefix` attribute.
	Cidr         *string           `pulumi:"cidr"`
	CustomFields map[string]string `pulumi:"customFields"`
	// Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Description *string `pulumi:"description"`
	// The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Family *int `pulumi:"family"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `cidr`.
	Prefix *string `pulumi:"prefix"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	RoleId *int `pulumi:"roleId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	SiteId *int `pulumi:"siteId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Status *string `pulumi:"status"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Tag *string `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN *string `pulumi:"tagN"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	TenantId *int `pulumi:"tenantId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanId *int `pulumi:"vlanId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanVid *float64 `pulumi:"vlanVid"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VrfId *int `pulumi:"vrfId"`
}

A collection of arguments for invoking getPrefix.

type LookupPrefixOutputArgs

type LookupPrefixOutputArgs struct {
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `prefix`.
	//
	// Deprecated: The `cidr` parameter is deprecated in favor of the canonical `prefix` attribute.
	Cidr         pulumi.StringPtrInput `pulumi:"cidr"`
	CustomFields pulumi.StringMapInput `pulumi:"customFields"`
	// Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Family pulumi.IntPtrInput `pulumi:"family"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `cidr`.
	Prefix pulumi.StringPtrInput `pulumi:"prefix"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	RoleId pulumi.IntPtrInput `pulumi:"roleId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	SiteId pulumi.IntPtrInput `pulumi:"siteId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Status pulumi.StringPtrInput `pulumi:"status"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Tag pulumi.StringPtrInput `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN pulumi.StringPtrInput `pulumi:"tagN"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	TenantId pulumi.IntPtrInput `pulumi:"tenantId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanId pulumi.IntPtrInput `pulumi:"vlanId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanVid pulumi.Float64PtrInput `pulumi:"vlanVid"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VrfId pulumi.IntPtrInput `pulumi:"vrfId"`
}

A collection of arguments for invoking getPrefix.

func (LookupPrefixOutputArgs) ElementType

func (LookupPrefixOutputArgs) ElementType() reflect.Type

type LookupPrefixResult

type LookupPrefixResult struct {
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `prefix`.
	//
	// Deprecated: The `cidr` parameter is deprecated in favor of the canonical `prefix` attribute.
	Cidr         *string           `pulumi:"cidr"`
	CustomFields map[string]string `pulumi:"customFields"`
	// Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Description string `pulumi:"description"`
	// The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Family int `pulumi:"family"`
	// The ID of this resource.
	Id         int `pulumi:"id"`
	LocationId int `pulumi:"locationId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `cidr`.
	Prefix   *string `pulumi:"prefix"`
	RegionId int     `pulumi:"regionId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	RoleId      int `pulumi:"roleId"`
	SiteGroupId int `pulumi:"siteGroupId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	SiteId *int `pulumi:"siteId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Status *string `pulumi:"status"`
	// Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	Tag *string `pulumi:"tag"`
	// Tag to exclude from the data source filter (must match the tag's slug).
	// Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
	// for more information on available lookup expressions.
	TagN *string  `pulumi:"tagN"`
	Tags []string `pulumi:"tags"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	TenantId *int `pulumi:"tenantId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanId *int `pulumi:"vlanId"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VlanVid *float64 `pulumi:"vlanVid"`
	// At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.
	VrfId *int `pulumi:"vrfId"`
}

A collection of values returned by getPrefix.

func LookupPrefix

func LookupPrefix(ctx *pulumi.Context, args *LookupPrefixArgs, opts ...pulumi.InvokeOption) (*LookupPrefixResult, error)

type LookupPrefixResultOutput

type LookupPrefixResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPrefix.

func (LookupPrefixResultOutput) Cidr deprecated

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `prefix`.

Deprecated: The `cidr` parameter is deprecated in favor of the canonical `prefix` attribute.

func (LookupPrefixResultOutput) CustomFields

func (LookupPrefixResultOutput) Description

Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) ElementType

func (LookupPrefixResultOutput) ElementType() reflect.Type

func (LookupPrefixResultOutput) Family

The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) Id

The ID of this resource.

func (LookupPrefixResultOutput) LocationId

func (o LookupPrefixResultOutput) LocationId() pulumi.IntOutput

func (LookupPrefixResultOutput) Prefix

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given. Conflicts with `cidr`.

func (LookupPrefixResultOutput) RegionId

func (LookupPrefixResultOutput) RoleId

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) SiteGroupId

func (o LookupPrefixResultOutput) SiteGroupId() pulumi.IntOutput

func (LookupPrefixResultOutput) SiteId

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) Status

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) Tag

Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) TagN

Tag to exclude from the data source filter (must match the tag's slug). Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions) for more information on available lookup expressions.

func (LookupPrefixResultOutput) Tags

func (LookupPrefixResultOutput) TenantId

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) ToLookupPrefixResultOutput

func (o LookupPrefixResultOutput) ToLookupPrefixResultOutput() LookupPrefixResultOutput

func (LookupPrefixResultOutput) ToLookupPrefixResultOutputWithContext

func (o LookupPrefixResultOutput) ToLookupPrefixResultOutputWithContext(ctx context.Context) LookupPrefixResultOutput

func (LookupPrefixResultOutput) VlanId

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) VlanVid

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

func (LookupPrefixResultOutput) VrfId

At least one of `description`, `family`, `prefix`, `vlanVid`, `vrfId`, `vlanId`, `tenantId`, `siteId`, `roleId`, `cidr`, `tag` or `status` must be given.

type LookupRoleArgs

type LookupRoleArgs struct {
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getRole.

type LookupRoleOutputArgs

type LookupRoleOutputArgs struct {
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getRole.

func (LookupRoleOutputArgs) ElementType

func (LookupRoleOutputArgs) ElementType() reflect.Type

type LookupRoleResult

type LookupRoleResult struct {
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id     string `pulumi:"id"`
	Name   string `pulumi:"name"`
	Slug   string `pulumi:"slug"`
	Weight int    `pulumi:"weight"`
}

A collection of values returned by getRole.

func LookupRole

func LookupRole(ctx *pulumi.Context, args *LookupRoleArgs, opts ...pulumi.InvokeOption) (*LookupRoleResult, error)

type LookupRoleResultOutput

type LookupRoleResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getRole.

func (LookupRoleResultOutput) Description

func (o LookupRoleResultOutput) Description() pulumi.StringOutput

func (LookupRoleResultOutput) ElementType

func (LookupRoleResultOutput) ElementType() reflect.Type

func (LookupRoleResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupRoleResultOutput) Name

func (LookupRoleResultOutput) Slug

func (LookupRoleResultOutput) ToLookupRoleResultOutput

func (o LookupRoleResultOutput) ToLookupRoleResultOutput() LookupRoleResultOutput

func (LookupRoleResultOutput) ToLookupRoleResultOutputWithContext

func (o LookupRoleResultOutput) ToLookupRoleResultOutputWithContext(ctx context.Context) LookupRoleResultOutput

func (LookupRoleResultOutput) Weight

type LookupRouteTargetArgs

type LookupRouteTargetArgs struct {
	Name string   `pulumi:"name"`
	Tags []string `pulumi:"tags"`
}

A collection of arguments for invoking getRouteTarget.

type LookupRouteTargetOutputArgs

type LookupRouteTargetOutputArgs struct {
	Name pulumi.StringInput      `pulumi:"name"`
	Tags pulumi.StringArrayInput `pulumi:"tags"`
}

A collection of arguments for invoking getRouteTarget.

func (LookupRouteTargetOutputArgs) ElementType

type LookupRouteTargetResult

type LookupRouteTargetResult struct {
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id       string   `pulumi:"id"`
	Name     string   `pulumi:"name"`
	Tags     []string `pulumi:"tags"`
	TenantId int      `pulumi:"tenantId"`
}

A collection of values returned by getRouteTarget.

type LookupRouteTargetResultOutput

type LookupRouteTargetResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getRouteTarget.

func (LookupRouteTargetResultOutput) Description

func (LookupRouteTargetResultOutput) ElementType

func (LookupRouteTargetResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupRouteTargetResultOutput) Name

func (LookupRouteTargetResultOutput) Tags

func (LookupRouteTargetResultOutput) TenantId

func (LookupRouteTargetResultOutput) ToLookupRouteTargetResultOutput

func (o LookupRouteTargetResultOutput) ToLookupRouteTargetResultOutput() LookupRouteTargetResultOutput

func (LookupRouteTargetResultOutput) ToLookupRouteTargetResultOutputWithContext

func (o LookupRouteTargetResultOutput) ToLookupRouteTargetResultOutputWithContext(ctx context.Context) LookupRouteTargetResultOutput

type LookupVlanArgs

type LookupVlanArgs struct {
	GroupId *int    `pulumi:"groupId"`
	Name    *string `pulumi:"name"`
	Role    *int    `pulumi:"role"`
	Tenant  *int    `pulumi:"tenant"`
	Vid     *int    `pulumi:"vid"`
}

A collection of arguments for invoking getVlan.

type LookupVlanGroupArgs

type LookupVlanGroupArgs struct {
	// At least one of `name`, `slug` or `scopeType` must be given.
	Name *string `pulumi:"name"`
	// Required when `scopeType` is set.
	ScopeId *int `pulumi:"scopeId"`
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `name`, `slug` or `scopeType` must be given.
	ScopeType *string `pulumi:"scopeType"`
	// At least one of `name`, `slug` or `scopeType` must be given.
	Slug *string `pulumi:"slug"`
}

A collection of arguments for invoking getVlanGroup.

type LookupVlanGroupOutputArgs

type LookupVlanGroupOutputArgs struct {
	// At least one of `name`, `slug` or `scopeType` must be given.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Required when `scopeType` is set.
	ScopeId pulumi.IntPtrInput `pulumi:"scopeId"`
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `name`, `slug` or `scopeType` must be given.
	ScopeType pulumi.StringPtrInput `pulumi:"scopeType"`
	// At least one of `name`, `slug` or `scopeType` must be given.
	Slug pulumi.StringPtrInput `pulumi:"slug"`
}

A collection of arguments for invoking getVlanGroup.

func (LookupVlanGroupOutputArgs) ElementType

func (LookupVlanGroupOutputArgs) ElementType() reflect.Type

type LookupVlanGroupResult

type LookupVlanGroupResult struct {
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// At least one of `name`, `slug` or `scopeType` must be given.
	Name string `pulumi:"name"`
	// Required when `scopeType` is set.
	ScopeId *int `pulumi:"scopeId"`
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `name`, `slug` or `scopeType` must be given.
	ScopeType *string `pulumi:"scopeType"`
	// At least one of `name`, `slug` or `scopeType` must be given.
	Slug      string `pulumi:"slug"`
	VlanCount int    `pulumi:"vlanCount"`
}

A collection of values returned by getVlanGroup.

func LookupVlanGroup

func LookupVlanGroup(ctx *pulumi.Context, args *LookupVlanGroupArgs, opts ...pulumi.InvokeOption) (*LookupVlanGroupResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get VLAN group by name
		_, err := ipam.LookupVlanGroup(ctx, &ipam.LookupVlanGroupArgs{
			Name: pulumi.StringRef("example1"),
		}, nil)
		if err != nil {
			return err
		}
		// Get VLAN group by stub
		_, err = ipam.LookupVlanGroup(ctx, &ipam.LookupVlanGroupArgs{
			Slug: pulumi.StringRef("example2"),
		}, nil)
		if err != nil {
			return err
		}
		// Get VLAN group by name and scope_type/id
		_, err = ipam.LookupVlanGroup(ctx, &ipam.LookupVlanGroupArgs{
			Name:      pulumi.StringRef("example"),
			ScopeType: pulumi.StringRef("dcim.site"),
			ScopeId:   pulumi.IntRef(example.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupVlanGroupResultOutput

type LookupVlanGroupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVlanGroup.

func (LookupVlanGroupResultOutput) Description

func (LookupVlanGroupResultOutput) ElementType

func (LookupVlanGroupResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupVlanGroupResultOutput) Name

At least one of `name`, `slug` or `scopeType` must be given.

func (LookupVlanGroupResultOutput) ScopeId

Required when `scopeType` is set.

func (LookupVlanGroupResultOutput) ScopeType

Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`. At least one of `name`, `slug` or `scopeType` must be given.

func (LookupVlanGroupResultOutput) Slug

At least one of `name`, `slug` or `scopeType` must be given.

func (LookupVlanGroupResultOutput) ToLookupVlanGroupResultOutput

func (o LookupVlanGroupResultOutput) ToLookupVlanGroupResultOutput() LookupVlanGroupResultOutput

func (LookupVlanGroupResultOutput) ToLookupVlanGroupResultOutputWithContext

func (o LookupVlanGroupResultOutput) ToLookupVlanGroupResultOutputWithContext(ctx context.Context) LookupVlanGroupResultOutput

func (LookupVlanGroupResultOutput) VlanCount

type LookupVlanOutputArgs

type LookupVlanOutputArgs struct {
	GroupId pulumi.IntPtrInput    `pulumi:"groupId"`
	Name    pulumi.StringPtrInput `pulumi:"name"`
	Role    pulumi.IntPtrInput    `pulumi:"role"`
	Tenant  pulumi.IntPtrInput    `pulumi:"tenant"`
	Vid     pulumi.IntPtrInput    `pulumi:"vid"`
}

A collection of arguments for invoking getVlan.

func (LookupVlanOutputArgs) ElementType

func (LookupVlanOutputArgs) ElementType() reflect.Type

type LookupVlanResult

type LookupVlanResult struct {
	Description string `pulumi:"description"`
	GroupId     int    `pulumi:"groupId"`
	// The provider-assigned unique ID for this managed resource.
	Id     string  `pulumi:"id"`
	Name   *string `pulumi:"name"`
	Role   int     `pulumi:"role"`
	Site   int     `pulumi:"site"`
	Status string  `pulumi:"status"`
	Tenant int     `pulumi:"tenant"`
	Vid    *int    `pulumi:"vid"`
}

A collection of values returned by getVlan.

func LookupVlan

func LookupVlan(ctx *pulumi.Context, args *LookupVlanArgs, opts ...pulumi.InvokeOption) (*LookupVlanResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get VLAN by name
		_, err := ipam.LookupVlan(ctx, &ipam.LookupVlanArgs{
			Name: pulumi.StringRef("vlan-1"),
		}, nil)
		if err != nil {
			return err
		}
		// Get VLAN by VID and IPAM role ID
		_, err = ipam.LookupVlan(ctx, &ipam.LookupVlanArgs{
			Vid:  pulumi.IntRef(1234),
			Role: pulumi.IntRef(example.Id),
		}, nil)
		if err != nil {
			return err
		}
		// Get VLAN by name and tenant ID
		_, err = ipam.LookupVlan(ctx, &ipam.LookupVlanArgs{
			Name:   pulumi.StringRef("vlan-3"),
			Tenant: pulumi.IntRef(exampleNetboxTenant.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupVlanResultOutput

type LookupVlanResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVlan.

func (LookupVlanResultOutput) Description

func (o LookupVlanResultOutput) Description() pulumi.StringOutput

func (LookupVlanResultOutput) ElementType

func (LookupVlanResultOutput) ElementType() reflect.Type

func (LookupVlanResultOutput) GroupId

func (LookupVlanResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupVlanResultOutput) Name

func (LookupVlanResultOutput) Role

func (LookupVlanResultOutput) Site

func (LookupVlanResultOutput) Status

func (LookupVlanResultOutput) Tenant

func (LookupVlanResultOutput) ToLookupVlanResultOutput

func (o LookupVlanResultOutput) ToLookupVlanResultOutput() LookupVlanResultOutput

func (LookupVlanResultOutput) ToLookupVlanResultOutputWithContext

func (o LookupVlanResultOutput) ToLookupVlanResultOutputWithContext(ctx context.Context) LookupVlanResultOutput

func (LookupVlanResultOutput) Vid

type LookupVrfArgs

type LookupVrfArgs struct {
	Name     string `pulumi:"name"`
	TenantId *int   `pulumi:"tenantId"`
}

A collection of arguments for invoking getVrf.

type LookupVrfOutputArgs

type LookupVrfOutputArgs struct {
	Name     pulumi.StringInput `pulumi:"name"`
	TenantId pulumi.IntPtrInput `pulumi:"tenantId"`
}

A collection of arguments for invoking getVrf.

func (LookupVrfOutputArgs) ElementType

func (LookupVrfOutputArgs) ElementType() reflect.Type

type LookupVrfResult

type LookupVrfResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id       string `pulumi:"id"`
	Name     string `pulumi:"name"`
	TenantId *int   `pulumi:"tenantId"`
}

A collection of values returned by getVrf.

func LookupVrf

func LookupVrf(ctx *pulumi.Context, args *LookupVrfArgs, opts ...pulumi.InvokeOption) (*LookupVrfResult, error)

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.LookupVrf(ctx, &ipam.LookupVrfArgs{
			Name: "cust-a-prod",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupVrfResultOutput

type LookupVrfResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVrf.

func (LookupVrfResultOutput) ElementType

func (LookupVrfResultOutput) ElementType() reflect.Type

func (LookupVrfResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupVrfResultOutput) Name

func (LookupVrfResultOutput) TenantId

func (LookupVrfResultOutput) ToLookupVrfResultOutput

func (o LookupVrfResultOutput) ToLookupVrfResultOutput() LookupVrfResultOutput

func (LookupVrfResultOutput) ToLookupVrfResultOutputWithContext

func (o LookupVrfResultOutput) ToLookupVrfResultOutputWithContext(ctx context.Context) LookupVrfResultOutput

type Prefix

type Prefix struct {
	pulumi.CustomResourceState

	CustomFields pulumi.StringMapOutput `pulumi:"customFields"`
	Description  pulumi.StringPtrOutput `pulumi:"description"`
	IsPool       pulumi.BoolPtrOutput   `pulumi:"isPool"`
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId   pulumi.IntPtrOutput  `pulumi:"locationId"`
	MarkUtilized pulumi.BoolPtrOutput `pulumi:"markUtilized"`
	Prefix       pulumi.StringOutput  `pulumi:"prefix"`
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrOutput `pulumi:"regionId"`
	RoleId   pulumi.IntPtrOutput `pulumi:"roleId"`
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrOutput `pulumi:"siteGroupId"`
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrOutput `pulumi:"siteId"`
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringOutput      `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	VlanId   pulumi.IntPtrOutput      `pulumi:"vlanId"`
	VrfId    pulumi.IntPtrOutput      `pulumi:"vrfId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#prefixes):

> A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: All bits in the address not covered by the mask must be zero. (In other words, a prefix cannot be a specific IP address.) > > Prefixes are automatically organized by their parent aggregates. Additionally, each prefix can be assigned to a particular site and virtual routing and forwarding instance (VRF). Each VRF represents a separate IP space or routing table. All prefixes not assigned to a VRF are considered to be in the "global" table.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewPrefix(ctx, "my_prefix", &ipam.PrefixArgs{
			Prefix:      pulumi.String("10.0.0.0/24"),
			Status:      pulumi.String("active"),
			Description: pulumi.String("test prefix"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetPrefix

func GetPrefix(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrefixState, opts ...pulumi.ResourceOption) (*Prefix, error)

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).

func NewPrefix

func NewPrefix(ctx *pulumi.Context,
	name string, args *PrefixArgs, opts ...pulumi.ResourceOption) (*Prefix, error)

NewPrefix registers a new resource with the given unique name, arguments, and options.

func (*Prefix) ElementType

func (*Prefix) ElementType() reflect.Type

func (*Prefix) ToPrefixOutput

func (i *Prefix) ToPrefixOutput() PrefixOutput

func (*Prefix) ToPrefixOutputWithContext

func (i *Prefix) ToPrefixOutputWithContext(ctx context.Context) PrefixOutput

type PrefixArgs

type PrefixArgs struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	IsPool       pulumi.BoolPtrInput
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId   pulumi.IntPtrInput
	MarkUtilized pulumi.BoolPtrInput
	Prefix       pulumi.StringInput
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrInput
	RoleId   pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrInput
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VlanId   pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

The set of arguments for constructing a Prefix resource.

func (PrefixArgs) ElementType

func (PrefixArgs) ElementType() reflect.Type

type PrefixArray

type PrefixArray []PrefixInput

func (PrefixArray) ElementType

func (PrefixArray) ElementType() reflect.Type

func (PrefixArray) ToPrefixArrayOutput

func (i PrefixArray) ToPrefixArrayOutput() PrefixArrayOutput

func (PrefixArray) ToPrefixArrayOutputWithContext

func (i PrefixArray) ToPrefixArrayOutputWithContext(ctx context.Context) PrefixArrayOutput

type PrefixArrayInput

type PrefixArrayInput interface {
	pulumi.Input

	ToPrefixArrayOutput() PrefixArrayOutput
	ToPrefixArrayOutputWithContext(context.Context) PrefixArrayOutput
}

PrefixArrayInput is an input type that accepts PrefixArray and PrefixArrayOutput values. You can construct a concrete instance of `PrefixArrayInput` via:

PrefixArray{ PrefixArgs{...} }

type PrefixArrayOutput

type PrefixArrayOutput struct{ *pulumi.OutputState }

func (PrefixArrayOutput) ElementType

func (PrefixArrayOutput) ElementType() reflect.Type

func (PrefixArrayOutput) Index

func (PrefixArrayOutput) ToPrefixArrayOutput

func (o PrefixArrayOutput) ToPrefixArrayOutput() PrefixArrayOutput

func (PrefixArrayOutput) ToPrefixArrayOutputWithContext

func (o PrefixArrayOutput) ToPrefixArrayOutputWithContext(ctx context.Context) PrefixArrayOutput

type PrefixInput

type PrefixInput interface {
	pulumi.Input

	ToPrefixOutput() PrefixOutput
	ToPrefixOutputWithContext(ctx context.Context) PrefixOutput
}

type PrefixMap

type PrefixMap map[string]PrefixInput

func (PrefixMap) ElementType

func (PrefixMap) ElementType() reflect.Type

func (PrefixMap) ToPrefixMapOutput

func (i PrefixMap) ToPrefixMapOutput() PrefixMapOutput

func (PrefixMap) ToPrefixMapOutputWithContext

func (i PrefixMap) ToPrefixMapOutputWithContext(ctx context.Context) PrefixMapOutput

type PrefixMapInput

type PrefixMapInput interface {
	pulumi.Input

	ToPrefixMapOutput() PrefixMapOutput
	ToPrefixMapOutputWithContext(context.Context) PrefixMapOutput
}

PrefixMapInput is an input type that accepts PrefixMap and PrefixMapOutput values. You can construct a concrete instance of `PrefixMapInput` via:

PrefixMap{ "key": PrefixArgs{...} }

type PrefixMapOutput

type PrefixMapOutput struct{ *pulumi.OutputState }

func (PrefixMapOutput) ElementType

func (PrefixMapOutput) ElementType() reflect.Type

func (PrefixMapOutput) MapIndex

func (PrefixMapOutput) ToPrefixMapOutput

func (o PrefixMapOutput) ToPrefixMapOutput() PrefixMapOutput

func (PrefixMapOutput) ToPrefixMapOutputWithContext

func (o PrefixMapOutput) ToPrefixMapOutputWithContext(ctx context.Context) PrefixMapOutput

type PrefixOutput

type PrefixOutput struct{ *pulumi.OutputState }

func (PrefixOutput) CustomFields

func (o PrefixOutput) CustomFields() pulumi.StringMapOutput

func (PrefixOutput) Description

func (o PrefixOutput) Description() pulumi.StringPtrOutput

func (PrefixOutput) ElementType

func (PrefixOutput) ElementType() reflect.Type

func (PrefixOutput) IsPool

func (o PrefixOutput) IsPool() pulumi.BoolPtrOutput

func (PrefixOutput) LocationId

func (o PrefixOutput) LocationId() pulumi.IntPtrOutput

Conflicts with `siteId`, `siteGroupId` and `regionId`.

func (PrefixOutput) MarkUtilized

func (o PrefixOutput) MarkUtilized() pulumi.BoolPtrOutput

func (PrefixOutput) Prefix

func (o PrefixOutput) Prefix() pulumi.StringOutput

func (PrefixOutput) RegionId

func (o PrefixOutput) RegionId() pulumi.IntPtrOutput

Conflicts with `locationId`, `siteId` and `siteGroupId`.

func (PrefixOutput) RoleId

func (o PrefixOutput) RoleId() pulumi.IntPtrOutput

func (PrefixOutput) SiteGroupId

func (o PrefixOutput) SiteGroupId() pulumi.IntPtrOutput

Conflicts with `locationId`, `siteId` and `regionId`.

func (PrefixOutput) SiteId

func (o PrefixOutput) SiteId() pulumi.IntPtrOutput

Conflicts with `locationId`, `siteGroupId` and `regionId`.

func (PrefixOutput) Status

func (o PrefixOutput) Status() pulumi.StringOutput

Valid values are `active`, `container`, `reserved` and `deprecated`.

func (PrefixOutput) Tags

func (PrefixOutput) TagsAlls

func (o PrefixOutput) TagsAlls() pulumi.StringArrayOutput

func (PrefixOutput) TenantId

func (o PrefixOutput) TenantId() pulumi.IntPtrOutput

func (PrefixOutput) ToPrefixOutput

func (o PrefixOutput) ToPrefixOutput() PrefixOutput

func (PrefixOutput) ToPrefixOutputWithContext

func (o PrefixOutput) ToPrefixOutputWithContext(ctx context.Context) PrefixOutput

func (PrefixOutput) VlanId

func (o PrefixOutput) VlanId() pulumi.IntPtrOutput

func (PrefixOutput) VrfId

func (o PrefixOutput) VrfId() pulumi.IntPtrOutput

type PrefixState

type PrefixState struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	IsPool       pulumi.BoolPtrInput
	// Conflicts with `siteId`, `siteGroupId` and `regionId`.
	LocationId   pulumi.IntPtrInput
	MarkUtilized pulumi.BoolPtrInput
	Prefix       pulumi.StringPtrInput
	// Conflicts with `locationId`, `siteId` and `siteGroupId`.
	RegionId pulumi.IntPtrInput
	RoleId   pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteId` and `regionId`.
	SiteGroupId pulumi.IntPtrInput
	// Conflicts with `locationId`, `siteGroupId` and `regionId`.
	SiteId pulumi.IntPtrInput
	// Valid values are `active`, `container`, `reserved` and `deprecated`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	VlanId   pulumi.IntPtrInput
	VrfId    pulumi.IntPtrInput
}

func (PrefixState) ElementType

func (PrefixState) ElementType() reflect.Type

type Rir

type Rir struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Defaults to `false`.
	IsPrivate pulumi.BoolPtrOutput `pulumi:"isPrivate"`
	Name      pulumi.StringOutput  `pulumi:"name"`
	Slug      pulumi.StringOutput  `pulumi:"slug"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#regional-internet-registries-rirs):

> Regional Internet registries are responsible for the allocation of globally-routable address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for internal use, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which "owns" certain address space. There also exist lower-tier registries which serve particular geographic areas.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewRir(ctx, "test", &ipam.RirArgs{
			Name:        pulumi.String("test"),
			Description: pulumi.String("my description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetRir

func GetRir(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RirState, opts ...pulumi.ResourceOption) (*Rir, error)

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).

func NewRir

func NewRir(ctx *pulumi.Context,
	name string, args *RirArgs, opts ...pulumi.ResourceOption) (*Rir, error)

NewRir registers a new resource with the given unique name, arguments, and options.

func (*Rir) ElementType

func (*Rir) ElementType() reflect.Type

func (*Rir) ToRirOutput

func (i *Rir) ToRirOutput() RirOutput

func (*Rir) ToRirOutputWithContext

func (i *Rir) ToRirOutputWithContext(ctx context.Context) RirOutput

type RirArgs

type RirArgs struct {
	Description pulumi.StringPtrInput
	// Defaults to `false`.
	IsPrivate pulumi.BoolPtrInput
	Name      pulumi.StringPtrInput
	Slug      pulumi.StringPtrInput
}

The set of arguments for constructing a Rir resource.

func (RirArgs) ElementType

func (RirArgs) ElementType() reflect.Type

type RirArray

type RirArray []RirInput

func (RirArray) ElementType

func (RirArray) ElementType() reflect.Type

func (RirArray) ToRirArrayOutput

func (i RirArray) ToRirArrayOutput() RirArrayOutput

func (RirArray) ToRirArrayOutputWithContext

func (i RirArray) ToRirArrayOutputWithContext(ctx context.Context) RirArrayOutput

type RirArrayInput

type RirArrayInput interface {
	pulumi.Input

	ToRirArrayOutput() RirArrayOutput
	ToRirArrayOutputWithContext(context.Context) RirArrayOutput
}

RirArrayInput is an input type that accepts RirArray and RirArrayOutput values. You can construct a concrete instance of `RirArrayInput` via:

RirArray{ RirArgs{...} }

type RirArrayOutput

type RirArrayOutput struct{ *pulumi.OutputState }

func (RirArrayOutput) ElementType

func (RirArrayOutput) ElementType() reflect.Type

func (RirArrayOutput) Index

func (RirArrayOutput) ToRirArrayOutput

func (o RirArrayOutput) ToRirArrayOutput() RirArrayOutput

func (RirArrayOutput) ToRirArrayOutputWithContext

func (o RirArrayOutput) ToRirArrayOutputWithContext(ctx context.Context) RirArrayOutput

type RirInput

type RirInput interface {
	pulumi.Input

	ToRirOutput() RirOutput
	ToRirOutputWithContext(ctx context.Context) RirOutput
}

type RirMap

type RirMap map[string]RirInput

func (RirMap) ElementType

func (RirMap) ElementType() reflect.Type

func (RirMap) ToRirMapOutput

func (i RirMap) ToRirMapOutput() RirMapOutput

func (RirMap) ToRirMapOutputWithContext

func (i RirMap) ToRirMapOutputWithContext(ctx context.Context) RirMapOutput

type RirMapInput

type RirMapInput interface {
	pulumi.Input

	ToRirMapOutput() RirMapOutput
	ToRirMapOutputWithContext(context.Context) RirMapOutput
}

RirMapInput is an input type that accepts RirMap and RirMapOutput values. You can construct a concrete instance of `RirMapInput` via:

RirMap{ "key": RirArgs{...} }

type RirMapOutput

type RirMapOutput struct{ *pulumi.OutputState }

func (RirMapOutput) ElementType

func (RirMapOutput) ElementType() reflect.Type

func (RirMapOutput) MapIndex

func (o RirMapOutput) MapIndex(k pulumi.StringInput) RirOutput

func (RirMapOutput) ToRirMapOutput

func (o RirMapOutput) ToRirMapOutput() RirMapOutput

func (RirMapOutput) ToRirMapOutputWithContext

func (o RirMapOutput) ToRirMapOutputWithContext(ctx context.Context) RirMapOutput

type RirOutput

type RirOutput struct{ *pulumi.OutputState }

func (RirOutput) Description

func (o RirOutput) Description() pulumi.StringPtrOutput

func (RirOutput) ElementType

func (RirOutput) ElementType() reflect.Type

func (RirOutput) IsPrivate

func (o RirOutput) IsPrivate() pulumi.BoolPtrOutput

Defaults to `false`.

func (RirOutput) Name

func (o RirOutput) Name() pulumi.StringOutput

func (RirOutput) Slug

func (o RirOutput) Slug() pulumi.StringOutput

func (RirOutput) ToRirOutput

func (o RirOutput) ToRirOutput() RirOutput

func (RirOutput) ToRirOutputWithContext

func (o RirOutput) ToRirOutputWithContext(ctx context.Context) RirOutput

type RirState

type RirState struct {
	Description pulumi.StringPtrInput
	// Defaults to `false`.
	IsPrivate pulumi.BoolPtrInput
	Name      pulumi.StringPtrInput
	Slug      pulumi.StringPtrInput
}

func (RirState) ElementType

func (RirState) ElementType() reflect.Type

type Role

type Role struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput `pulumi:"description"`
	Name        pulumi.StringOutput    `pulumi:"name"`
	Slug        pulumi.StringOutput    `pulumi:"slug"`
	Weight      pulumi.IntPtrOutput    `pulumi:"weight"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#prefixvlan-roles):

> A role indicates the function of a prefix or VLAN. For example, you might define Data, Voice, and Security roles. Generally, a prefix will be assigned the same functional role as the VLAN to which it is assigned (if any).

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewRole(ctx, "test_basic", &ipam.RoleArgs{
			Name: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetRole

func GetRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RoleState, opts ...pulumi.ResourceOption) (*Role, error)

GetRole gets an existing Role resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRole

func NewRole(ctx *pulumi.Context,
	name string, args *RoleArgs, opts ...pulumi.ResourceOption) (*Role, error)

NewRole registers a new resource with the given unique name, arguments, and options.

func (*Role) ElementType

func (*Role) ElementType() reflect.Type

func (*Role) ToRoleOutput

func (i *Role) ToRoleOutput() RoleOutput

func (*Role) ToRoleOutputWithContext

func (i *Role) ToRoleOutputWithContext(ctx context.Context) RoleOutput

type RoleArgs

type RoleArgs struct {
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	Slug        pulumi.StringPtrInput
	Weight      pulumi.IntPtrInput
}

The set of arguments for constructing a Role resource.

func (RoleArgs) ElementType

func (RoleArgs) ElementType() reflect.Type

type RoleArray

type RoleArray []RoleInput

func (RoleArray) ElementType

func (RoleArray) ElementType() reflect.Type

func (RoleArray) ToRoleArrayOutput

func (i RoleArray) ToRoleArrayOutput() RoleArrayOutput

func (RoleArray) ToRoleArrayOutputWithContext

func (i RoleArray) ToRoleArrayOutputWithContext(ctx context.Context) RoleArrayOutput

type RoleArrayInput

type RoleArrayInput interface {
	pulumi.Input

	ToRoleArrayOutput() RoleArrayOutput
	ToRoleArrayOutputWithContext(context.Context) RoleArrayOutput
}

RoleArrayInput is an input type that accepts RoleArray and RoleArrayOutput values. You can construct a concrete instance of `RoleArrayInput` via:

RoleArray{ RoleArgs{...} }

type RoleArrayOutput

type RoleArrayOutput struct{ *pulumi.OutputState }

func (RoleArrayOutput) ElementType

func (RoleArrayOutput) ElementType() reflect.Type

func (RoleArrayOutput) Index

func (RoleArrayOutput) ToRoleArrayOutput

func (o RoleArrayOutput) ToRoleArrayOutput() RoleArrayOutput

func (RoleArrayOutput) ToRoleArrayOutputWithContext

func (o RoleArrayOutput) ToRoleArrayOutputWithContext(ctx context.Context) RoleArrayOutput

type RoleInput

type RoleInput interface {
	pulumi.Input

	ToRoleOutput() RoleOutput
	ToRoleOutputWithContext(ctx context.Context) RoleOutput
}

type RoleMap

type RoleMap map[string]RoleInput

func (RoleMap) ElementType

func (RoleMap) ElementType() reflect.Type

func (RoleMap) ToRoleMapOutput

func (i RoleMap) ToRoleMapOutput() RoleMapOutput

func (RoleMap) ToRoleMapOutputWithContext

func (i RoleMap) ToRoleMapOutputWithContext(ctx context.Context) RoleMapOutput

type RoleMapInput

type RoleMapInput interface {
	pulumi.Input

	ToRoleMapOutput() RoleMapOutput
	ToRoleMapOutputWithContext(context.Context) RoleMapOutput
}

RoleMapInput is an input type that accepts RoleMap and RoleMapOutput values. You can construct a concrete instance of `RoleMapInput` via:

RoleMap{ "key": RoleArgs{...} }

type RoleMapOutput

type RoleMapOutput struct{ *pulumi.OutputState }

func (RoleMapOutput) ElementType

func (RoleMapOutput) ElementType() reflect.Type

func (RoleMapOutput) MapIndex

func (RoleMapOutput) ToRoleMapOutput

func (o RoleMapOutput) ToRoleMapOutput() RoleMapOutput

func (RoleMapOutput) ToRoleMapOutputWithContext

func (o RoleMapOutput) ToRoleMapOutputWithContext(ctx context.Context) RoleMapOutput

type RoleOutput

type RoleOutput struct{ *pulumi.OutputState }

func (RoleOutput) Description

func (o RoleOutput) Description() pulumi.StringPtrOutput

func (RoleOutput) ElementType

func (RoleOutput) ElementType() reflect.Type

func (RoleOutput) Name

func (o RoleOutput) Name() pulumi.StringOutput

func (RoleOutput) Slug

func (o RoleOutput) Slug() pulumi.StringOutput

func (RoleOutput) ToRoleOutput

func (o RoleOutput) ToRoleOutput() RoleOutput

func (RoleOutput) ToRoleOutputWithContext

func (o RoleOutput) ToRoleOutputWithContext(ctx context.Context) RoleOutput

func (RoleOutput) Weight

func (o RoleOutput) Weight() pulumi.IntPtrOutput

type RoleState

type RoleState struct {
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	Slug        pulumi.StringPtrInput
	Weight      pulumi.IntPtrInput
}

func (RoleState) ElementType

func (RoleState) ElementType() reflect.Type

type RouteTarget

type RouteTarget struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput   `pulumi:"description"`
	Name        pulumi.StringOutput      `pulumi:"name"`
	Tags        pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls    pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId    pulumi.IntPtrOutput      `pulumi:"tenantId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/models/ipam/routetarget/):

> A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can be assigned to individual VRFs in NetBox as import or export targets (or both) to model this exchange in an L3VPN. Each route target must be given a unique name, which should be in a format prescribed by RFC 4364, similar to a VR route distinguisher.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/tenancy"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := tenancy.NewTenant(ctx, "test", &tenancy.TenantArgs{
			Name: pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		_, err = ipam.NewRouteTarget(ctx, "test", &ipam.RouteTargetArgs{
			Name:        pulumi.String("test"),
			Description: pulumi.String("my description"),
			TenantId:    test.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetRouteTarget

func GetRouteTarget(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RouteTargetState, opts ...pulumi.ResourceOption) (*RouteTarget, error)

GetRouteTarget gets an existing RouteTarget resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRouteTarget

func NewRouteTarget(ctx *pulumi.Context,
	name string, args *RouteTargetArgs, opts ...pulumi.ResourceOption) (*RouteTarget, error)

NewRouteTarget registers a new resource with the given unique name, arguments, and options.

func (*RouteTarget) ElementType

func (*RouteTarget) ElementType() reflect.Type

func (*RouteTarget) ToRouteTargetOutput

func (i *RouteTarget) ToRouteTargetOutput() RouteTargetOutput

func (*RouteTarget) ToRouteTargetOutputWithContext

func (i *RouteTarget) ToRouteTargetOutputWithContext(ctx context.Context) RouteTargetOutput

type RouteTargetArgs

type RouteTargetArgs struct {
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	Tags        pulumi.StringArrayInput
	TenantId    pulumi.IntPtrInput
}

The set of arguments for constructing a RouteTarget resource.

func (RouteTargetArgs) ElementType

func (RouteTargetArgs) ElementType() reflect.Type

type RouteTargetArray

type RouteTargetArray []RouteTargetInput

func (RouteTargetArray) ElementType

func (RouteTargetArray) ElementType() reflect.Type

func (RouteTargetArray) ToRouteTargetArrayOutput

func (i RouteTargetArray) ToRouteTargetArrayOutput() RouteTargetArrayOutput

func (RouteTargetArray) ToRouteTargetArrayOutputWithContext

func (i RouteTargetArray) ToRouteTargetArrayOutputWithContext(ctx context.Context) RouteTargetArrayOutput

type RouteTargetArrayInput

type RouteTargetArrayInput interface {
	pulumi.Input

	ToRouteTargetArrayOutput() RouteTargetArrayOutput
	ToRouteTargetArrayOutputWithContext(context.Context) RouteTargetArrayOutput
}

RouteTargetArrayInput is an input type that accepts RouteTargetArray and RouteTargetArrayOutput values. You can construct a concrete instance of `RouteTargetArrayInput` via:

RouteTargetArray{ RouteTargetArgs{...} }

type RouteTargetArrayOutput

type RouteTargetArrayOutput struct{ *pulumi.OutputState }

func (RouteTargetArrayOutput) ElementType

func (RouteTargetArrayOutput) ElementType() reflect.Type

func (RouteTargetArrayOutput) Index

func (RouteTargetArrayOutput) ToRouteTargetArrayOutput

func (o RouteTargetArrayOutput) ToRouteTargetArrayOutput() RouteTargetArrayOutput

func (RouteTargetArrayOutput) ToRouteTargetArrayOutputWithContext

func (o RouteTargetArrayOutput) ToRouteTargetArrayOutputWithContext(ctx context.Context) RouteTargetArrayOutput

type RouteTargetInput

type RouteTargetInput interface {
	pulumi.Input

	ToRouteTargetOutput() RouteTargetOutput
	ToRouteTargetOutputWithContext(ctx context.Context) RouteTargetOutput
}

type RouteTargetMap

type RouteTargetMap map[string]RouteTargetInput

func (RouteTargetMap) ElementType

func (RouteTargetMap) ElementType() reflect.Type

func (RouteTargetMap) ToRouteTargetMapOutput

func (i RouteTargetMap) ToRouteTargetMapOutput() RouteTargetMapOutput

func (RouteTargetMap) ToRouteTargetMapOutputWithContext

func (i RouteTargetMap) ToRouteTargetMapOutputWithContext(ctx context.Context) RouteTargetMapOutput

type RouteTargetMapInput

type RouteTargetMapInput interface {
	pulumi.Input

	ToRouteTargetMapOutput() RouteTargetMapOutput
	ToRouteTargetMapOutputWithContext(context.Context) RouteTargetMapOutput
}

RouteTargetMapInput is an input type that accepts RouteTargetMap and RouteTargetMapOutput values. You can construct a concrete instance of `RouteTargetMapInput` via:

RouteTargetMap{ "key": RouteTargetArgs{...} }

type RouteTargetMapOutput

type RouteTargetMapOutput struct{ *pulumi.OutputState }

func (RouteTargetMapOutput) ElementType

func (RouteTargetMapOutput) ElementType() reflect.Type

func (RouteTargetMapOutput) MapIndex

func (RouteTargetMapOutput) ToRouteTargetMapOutput

func (o RouteTargetMapOutput) ToRouteTargetMapOutput() RouteTargetMapOutput

func (RouteTargetMapOutput) ToRouteTargetMapOutputWithContext

func (o RouteTargetMapOutput) ToRouteTargetMapOutputWithContext(ctx context.Context) RouteTargetMapOutput

type RouteTargetOutput

type RouteTargetOutput struct{ *pulumi.OutputState }

func (RouteTargetOutput) Description

func (o RouteTargetOutput) Description() pulumi.StringPtrOutput

func (RouteTargetOutput) ElementType

func (RouteTargetOutput) ElementType() reflect.Type

func (RouteTargetOutput) Name

func (RouteTargetOutput) Tags

func (RouteTargetOutput) TagsAlls

func (RouteTargetOutput) TenantId

func (o RouteTargetOutput) TenantId() pulumi.IntPtrOutput

func (RouteTargetOutput) ToRouteTargetOutput

func (o RouteTargetOutput) ToRouteTargetOutput() RouteTargetOutput

func (RouteTargetOutput) ToRouteTargetOutputWithContext

func (o RouteTargetOutput) ToRouteTargetOutputWithContext(ctx context.Context) RouteTargetOutput

type RouteTargetState

type RouteTargetState struct {
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	Tags        pulumi.StringArrayInput
	TagsAlls    pulumi.StringArrayInput
	TenantId    pulumi.IntPtrInput
}

func (RouteTargetState) ElementType

func (RouteTargetState) ElementType() reflect.Type

type Service

type Service struct {
	pulumi.CustomResourceState

	CustomFields pulumi.StringMapOutput `pulumi:"customFields"`
	Description  pulumi.StringPtrOutput `pulumi:"description"`
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	DeviceId pulumi.IntPtrOutput `pulumi:"deviceId"`
	Name     pulumi.StringOutput `pulumi:"name"`
	// Exactly one of `port` or `ports` must be given.
	//
	// Deprecated: This field is deprecated. Please use the new "ports" attribute instead.
	Port pulumi.IntPtrOutput `pulumi:"port"`
	// Exactly one of `port` or `ports` must be given.
	Ports pulumi.IntArrayOutput `pulumi:"ports"`
	// Valid values are `tcp`, `udp` and `sctp`.
	Protocol pulumi.StringOutput      `pulumi:"protocol"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	VirtualMachineId pulumi.IntPtrOutput `pulumi:"virtualMachineId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/services/#services):

> A service represents a layer four TCP or UDP service available on a device or virtual machine. For example, you might want to document that an HTTP service is running on a device. Each service includes a name, protocol, and port number; for example, "SSH (TCP/22)" or "DNS (UDP/53)." > > A service may optionally be bound to one or more specific IP addresses belonging to its parent device or VM. (If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.

func GetService

func GetService(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceState, opts ...pulumi.ResourceOption) (*Service, error)

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).

func NewService

func NewService(ctx *pulumi.Context,
	name string, args *ServiceArgs, opts ...pulumi.ResourceOption) (*Service, error)

NewService registers a new resource with the given unique name, arguments, and options.

func (*Service) ElementType

func (*Service) ElementType() reflect.Type

func (*Service) ToServiceOutput

func (i *Service) ToServiceOutput() ServiceOutput

func (*Service) ToServiceOutputWithContext

func (i *Service) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

type ServiceArgs

type ServiceArgs struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	DeviceId pulumi.IntPtrInput
	Name     pulumi.StringPtrInput
	// Exactly one of `port` or `ports` must be given.
	//
	// Deprecated: This field is deprecated. Please use the new "ports" attribute instead.
	Port pulumi.IntPtrInput
	// Exactly one of `port` or `ports` must be given.
	Ports pulumi.IntArrayInput
	// Valid values are `tcp`, `udp` and `sctp`.
	Protocol pulumi.StringInput
	Tags     pulumi.StringArrayInput
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	VirtualMachineId pulumi.IntPtrInput
}

The set of arguments for constructing a Service resource.

func (ServiceArgs) ElementType

func (ServiceArgs) ElementType() reflect.Type

type ServiceArray

type ServiceArray []ServiceInput

func (ServiceArray) ElementType

func (ServiceArray) ElementType() reflect.Type

func (ServiceArray) ToServiceArrayOutput

func (i ServiceArray) ToServiceArrayOutput() ServiceArrayOutput

func (ServiceArray) ToServiceArrayOutputWithContext

func (i ServiceArray) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput

type ServiceArrayInput

type ServiceArrayInput interface {
	pulumi.Input

	ToServiceArrayOutput() ServiceArrayOutput
	ToServiceArrayOutputWithContext(context.Context) ServiceArrayOutput
}

ServiceArrayInput is an input type that accepts ServiceArray and ServiceArrayOutput values. You can construct a concrete instance of `ServiceArrayInput` via:

ServiceArray{ ServiceArgs{...} }

type ServiceArrayOutput

type ServiceArrayOutput struct{ *pulumi.OutputState }

func (ServiceArrayOutput) ElementType

func (ServiceArrayOutput) ElementType() reflect.Type

func (ServiceArrayOutput) Index

func (ServiceArrayOutput) ToServiceArrayOutput

func (o ServiceArrayOutput) ToServiceArrayOutput() ServiceArrayOutput

func (ServiceArrayOutput) ToServiceArrayOutputWithContext

func (o ServiceArrayOutput) ToServiceArrayOutputWithContext(ctx context.Context) ServiceArrayOutput

type ServiceInput

type ServiceInput interface {
	pulumi.Input

	ToServiceOutput() ServiceOutput
	ToServiceOutputWithContext(ctx context.Context) ServiceOutput
}

type ServiceMap

type ServiceMap map[string]ServiceInput

func (ServiceMap) ElementType

func (ServiceMap) ElementType() reflect.Type

func (ServiceMap) ToServiceMapOutput

func (i ServiceMap) ToServiceMapOutput() ServiceMapOutput

func (ServiceMap) ToServiceMapOutputWithContext

func (i ServiceMap) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput

type ServiceMapInput

type ServiceMapInput interface {
	pulumi.Input

	ToServiceMapOutput() ServiceMapOutput
	ToServiceMapOutputWithContext(context.Context) ServiceMapOutput
}

ServiceMapInput is an input type that accepts ServiceMap and ServiceMapOutput values. You can construct a concrete instance of `ServiceMapInput` via:

ServiceMap{ "key": ServiceArgs{...} }

type ServiceMapOutput

type ServiceMapOutput struct{ *pulumi.OutputState }

func (ServiceMapOutput) ElementType

func (ServiceMapOutput) ElementType() reflect.Type

func (ServiceMapOutput) MapIndex

func (ServiceMapOutput) ToServiceMapOutput

func (o ServiceMapOutput) ToServiceMapOutput() ServiceMapOutput

func (ServiceMapOutput) ToServiceMapOutputWithContext

func (o ServiceMapOutput) ToServiceMapOutputWithContext(ctx context.Context) ServiceMapOutput

type ServiceOutput

type ServiceOutput struct{ *pulumi.OutputState }

func (ServiceOutput) CustomFields

func (o ServiceOutput) CustomFields() pulumi.StringMapOutput

func (ServiceOutput) Description

func (o ServiceOutput) Description() pulumi.StringPtrOutput

func (ServiceOutput) DeviceId

func (o ServiceOutput) DeviceId() pulumi.IntPtrOutput

Exactly one of `virtualMachineId` or `deviceId` must be given.

func (ServiceOutput) ElementType

func (ServiceOutput) ElementType() reflect.Type

func (ServiceOutput) Name

func (ServiceOutput) Port deprecated

Exactly one of `port` or `ports` must be given.

Deprecated: This field is deprecated. Please use the new "ports" attribute instead.

func (ServiceOutput) Ports

Exactly one of `port` or `ports` must be given.

func (ServiceOutput) Protocol

func (o ServiceOutput) Protocol() pulumi.StringOutput

Valid values are `tcp`, `udp` and `sctp`.

func (ServiceOutput) Tags

func (ServiceOutput) TagsAlls

func (o ServiceOutput) TagsAlls() pulumi.StringArrayOutput

func (ServiceOutput) ToServiceOutput

func (o ServiceOutput) ToServiceOutput() ServiceOutput

func (ServiceOutput) ToServiceOutputWithContext

func (o ServiceOutput) ToServiceOutputWithContext(ctx context.Context) ServiceOutput

func (ServiceOutput) VirtualMachineId

func (o ServiceOutput) VirtualMachineId() pulumi.IntPtrOutput

Exactly one of `virtualMachineId` or `deviceId` must be given.

type ServiceState

type ServiceState struct {
	CustomFields pulumi.StringMapInput
	Description  pulumi.StringPtrInput
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	DeviceId pulumi.IntPtrInput
	Name     pulumi.StringPtrInput
	// Exactly one of `port` or `ports` must be given.
	//
	// Deprecated: This field is deprecated. Please use the new "ports" attribute instead.
	Port pulumi.IntPtrInput
	// Exactly one of `port` or `ports` must be given.
	Ports pulumi.IntArrayInput
	// Valid values are `tcp`, `udp` and `sctp`.
	Protocol pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	// Exactly one of `virtualMachineId` or `deviceId` must be given.
	VirtualMachineId pulumi.IntPtrInput
}

func (ServiceState) ElementType

func (ServiceState) ElementType() reflect.Type

type Vlan

type Vlan struct {
	pulumi.CustomResourceState

	// Defaults to `""`.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	GroupId     pulumi.IntPtrOutput    `pulumi:"groupId"`
	Name        pulumi.StringOutput    `pulumi:"name"`
	RoleId      pulumi.IntPtrOutput    `pulumi:"roleId"`
	SiteId      pulumi.IntPtrOutput    `pulumi:"siteId"`
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrOutput   `pulumi:"status"`
	Tags     pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId pulumi.IntPtrOutput      `pulumi:"tenantId"`
	Vid      pulumi.IntOutput         `pulumi:"vid"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/vlans/#vlans):

> A VLAN represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged into VLAN groups to define scope and to enforce uniqueness.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewVlan(ctx, "example1", &ipam.VlanArgs{
			Name: pulumi.String("VLAN 1"),
			Vid:  pulumi.Int(1777),
			Tags: pulumi.StringArray{},
		})
		if err != nil {
			return err
		}
		// Assume netbox_tenant, netbox_site, and netbox_tag resources exist
		_, err = ipam.NewVlan(ctx, "example2", &ipam.VlanArgs{
			Name:        pulumi.String("VLAN 2"),
			Vid:         pulumi.Int(1778),
			Status:      pulumi.String("reserved"),
			Description: pulumi.String("Reserved example VLAN"),
			TenantId:    pulumi.Any(exNetboxTenant.Id),
			SiteId:      pulumi.Any(exNetboxSite.Id),
			GroupId:     pulumi.Any(ex.Id),
			Tags: pulumi.StringArray{
				exNetboxTag.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetVlan

func GetVlan(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VlanState, opts ...pulumi.ResourceOption) (*Vlan, error)

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).

func NewVlan

func NewVlan(ctx *pulumi.Context,
	name string, args *VlanArgs, opts ...pulumi.ResourceOption) (*Vlan, error)

NewVlan registers a new resource with the given unique name, arguments, and options.

func (*Vlan) ElementType

func (*Vlan) ElementType() reflect.Type

func (*Vlan) ToVlanOutput

func (i *Vlan) ToVlanOutput() VlanOutput

func (*Vlan) ToVlanOutputWithContext

func (i *Vlan) ToVlanOutputWithContext(ctx context.Context) VlanOutput

type VlanArgs

type VlanArgs struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	GroupId     pulumi.IntPtrInput
	Name        pulumi.StringPtrInput
	RoleId      pulumi.IntPtrInput
	SiteId      pulumi.IntPtrInput
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	Vid      pulumi.IntInput
}

The set of arguments for constructing a Vlan resource.

func (VlanArgs) ElementType

func (VlanArgs) ElementType() reflect.Type

type VlanArray

type VlanArray []VlanInput

func (VlanArray) ElementType

func (VlanArray) ElementType() reflect.Type

func (VlanArray) ToVlanArrayOutput

func (i VlanArray) ToVlanArrayOutput() VlanArrayOutput

func (VlanArray) ToVlanArrayOutputWithContext

func (i VlanArray) ToVlanArrayOutputWithContext(ctx context.Context) VlanArrayOutput

type VlanArrayInput

type VlanArrayInput interface {
	pulumi.Input

	ToVlanArrayOutput() VlanArrayOutput
	ToVlanArrayOutputWithContext(context.Context) VlanArrayOutput
}

VlanArrayInput is an input type that accepts VlanArray and VlanArrayOutput values. You can construct a concrete instance of `VlanArrayInput` via:

VlanArray{ VlanArgs{...} }

type VlanArrayOutput

type VlanArrayOutput struct{ *pulumi.OutputState }

func (VlanArrayOutput) ElementType

func (VlanArrayOutput) ElementType() reflect.Type

func (VlanArrayOutput) Index

func (VlanArrayOutput) ToVlanArrayOutput

func (o VlanArrayOutput) ToVlanArrayOutput() VlanArrayOutput

func (VlanArrayOutput) ToVlanArrayOutputWithContext

func (o VlanArrayOutput) ToVlanArrayOutputWithContext(ctx context.Context) VlanArrayOutput

type VlanGroup

type VlanGroup struct {
	pulumi.CustomResourceState

	// Defaults to `""`.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	Name        pulumi.StringOutput    `pulumi:"name"`
	// Required when `scopeType` is set.
	ScopeId pulumi.IntPtrOutput `pulumi:"scopeId"`
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
	ScopeType pulumi.StringPtrOutput     `pulumi:"scopeType"`
	Slug      pulumi.StringOutput        `pulumi:"slug"`
	Tags      pulumi.StringArrayOutput   `pulumi:"tags"`
	TagsAlls  pulumi.StringArrayOutput   `pulumi:"tagsAlls"`
	VidRanges pulumi.IntArrayArrayOutput `pulumi:"vidRanges"`
}

> A VLAN Group represents a collection of VLANs. Generally, these are limited by one of a number of scopes such as "Site" or "Virtualization Cluster".

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Basic VLAN Group example
		_, err := ipam.NewVlanGroup(ctx, "example1", &ipam.VlanGroupArgs{
			Name: pulumi.String("example1"),
			Slug: pulumi.String("example1"),
		})
		if err != nil {
			return err
		}
		// Full VLAN Group example
		_, err = ipam.NewVlanGroup(ctx, "example2", &ipam.VlanGroupArgs{
			Name:        pulumi.String("Second Example"),
			Slug:        pulumi.String("example2"),
			ScopeType:   pulumi.String("dcim.site"),
			ScopeId:     pulumi.Any(example.Id),
			Description: pulumi.String("Second Example VLAN Group"),
			Tags: pulumi.StringArray{
				exampleNetboxTag.Id,
			},
			VidRanges: pulumi.IntArrayArray{
				pulumi.IntArray{
					pulumi.Int(1),
					pulumi.Int(2),
				},
				pulumi.IntArray{
					pulumi.Int(3),
					pulumi.Int(4),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetVlanGroup

func GetVlanGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VlanGroupState, opts ...pulumi.ResourceOption) (*VlanGroup, error)

GetVlanGroup gets an existing VlanGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewVlanGroup

func NewVlanGroup(ctx *pulumi.Context,
	name string, args *VlanGroupArgs, opts ...pulumi.ResourceOption) (*VlanGroup, error)

NewVlanGroup registers a new resource with the given unique name, arguments, and options.

func (*VlanGroup) ElementType

func (*VlanGroup) ElementType() reflect.Type

func (*VlanGroup) ToVlanGroupOutput

func (i *VlanGroup) ToVlanGroupOutput() VlanGroupOutput

func (*VlanGroup) ToVlanGroupOutputWithContext

func (i *VlanGroup) ToVlanGroupOutputWithContext(ctx context.Context) VlanGroupOutput

type VlanGroupArgs

type VlanGroupArgs struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	// Required when `scopeType` is set.
	ScopeId pulumi.IntPtrInput
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
	ScopeType pulumi.StringPtrInput
	Slug      pulumi.StringInput
	Tags      pulumi.StringArrayInput
	VidRanges pulumi.IntArrayArrayInput
}

The set of arguments for constructing a VlanGroup resource.

func (VlanGroupArgs) ElementType

func (VlanGroupArgs) ElementType() reflect.Type

type VlanGroupArray

type VlanGroupArray []VlanGroupInput

func (VlanGroupArray) ElementType

func (VlanGroupArray) ElementType() reflect.Type

func (VlanGroupArray) ToVlanGroupArrayOutput

func (i VlanGroupArray) ToVlanGroupArrayOutput() VlanGroupArrayOutput

func (VlanGroupArray) ToVlanGroupArrayOutputWithContext

func (i VlanGroupArray) ToVlanGroupArrayOutputWithContext(ctx context.Context) VlanGroupArrayOutput

type VlanGroupArrayInput

type VlanGroupArrayInput interface {
	pulumi.Input

	ToVlanGroupArrayOutput() VlanGroupArrayOutput
	ToVlanGroupArrayOutputWithContext(context.Context) VlanGroupArrayOutput
}

VlanGroupArrayInput is an input type that accepts VlanGroupArray and VlanGroupArrayOutput values. You can construct a concrete instance of `VlanGroupArrayInput` via:

VlanGroupArray{ VlanGroupArgs{...} }

type VlanGroupArrayOutput

type VlanGroupArrayOutput struct{ *pulumi.OutputState }

func (VlanGroupArrayOutput) ElementType

func (VlanGroupArrayOutput) ElementType() reflect.Type

func (VlanGroupArrayOutput) Index

func (VlanGroupArrayOutput) ToVlanGroupArrayOutput

func (o VlanGroupArrayOutput) ToVlanGroupArrayOutput() VlanGroupArrayOutput

func (VlanGroupArrayOutput) ToVlanGroupArrayOutputWithContext

func (o VlanGroupArrayOutput) ToVlanGroupArrayOutputWithContext(ctx context.Context) VlanGroupArrayOutput

type VlanGroupInput

type VlanGroupInput interface {
	pulumi.Input

	ToVlanGroupOutput() VlanGroupOutput
	ToVlanGroupOutputWithContext(ctx context.Context) VlanGroupOutput
}

type VlanGroupMap

type VlanGroupMap map[string]VlanGroupInput

func (VlanGroupMap) ElementType

func (VlanGroupMap) ElementType() reflect.Type

func (VlanGroupMap) ToVlanGroupMapOutput

func (i VlanGroupMap) ToVlanGroupMapOutput() VlanGroupMapOutput

func (VlanGroupMap) ToVlanGroupMapOutputWithContext

func (i VlanGroupMap) ToVlanGroupMapOutputWithContext(ctx context.Context) VlanGroupMapOutput

type VlanGroupMapInput

type VlanGroupMapInput interface {
	pulumi.Input

	ToVlanGroupMapOutput() VlanGroupMapOutput
	ToVlanGroupMapOutputWithContext(context.Context) VlanGroupMapOutput
}

VlanGroupMapInput is an input type that accepts VlanGroupMap and VlanGroupMapOutput values. You can construct a concrete instance of `VlanGroupMapInput` via:

VlanGroupMap{ "key": VlanGroupArgs{...} }

type VlanGroupMapOutput

type VlanGroupMapOutput struct{ *pulumi.OutputState }

func (VlanGroupMapOutput) ElementType

func (VlanGroupMapOutput) ElementType() reflect.Type

func (VlanGroupMapOutput) MapIndex

func (VlanGroupMapOutput) ToVlanGroupMapOutput

func (o VlanGroupMapOutput) ToVlanGroupMapOutput() VlanGroupMapOutput

func (VlanGroupMapOutput) ToVlanGroupMapOutputWithContext

func (o VlanGroupMapOutput) ToVlanGroupMapOutputWithContext(ctx context.Context) VlanGroupMapOutput

type VlanGroupOutput

type VlanGroupOutput struct{ *pulumi.OutputState }

func (VlanGroupOutput) Description

func (o VlanGroupOutput) Description() pulumi.StringPtrOutput

Defaults to `""`.

func (VlanGroupOutput) ElementType

func (VlanGroupOutput) ElementType() reflect.Type

func (VlanGroupOutput) Name

func (VlanGroupOutput) ScopeId

func (o VlanGroupOutput) ScopeId() pulumi.IntPtrOutput

Required when `scopeType` is set.

func (VlanGroupOutput) ScopeType

func (o VlanGroupOutput) ScopeType() pulumi.StringPtrOutput

Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.

func (VlanGroupOutput) Slug

func (VlanGroupOutput) Tags

func (VlanGroupOutput) TagsAlls

func (VlanGroupOutput) ToVlanGroupOutput

func (o VlanGroupOutput) ToVlanGroupOutput() VlanGroupOutput

func (VlanGroupOutput) ToVlanGroupOutputWithContext

func (o VlanGroupOutput) ToVlanGroupOutputWithContext(ctx context.Context) VlanGroupOutput

func (VlanGroupOutput) VidRanges

type VlanGroupState

type VlanGroupState struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	Name        pulumi.StringPtrInput
	// Required when `scopeType` is set.
	ScopeId pulumi.IntPtrInput
	// Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
	ScopeType pulumi.StringPtrInput
	Slug      pulumi.StringPtrInput
	Tags      pulumi.StringArrayInput
	TagsAlls  pulumi.StringArrayInput
	VidRanges pulumi.IntArrayArrayInput
}

func (VlanGroupState) ElementType

func (VlanGroupState) ElementType() reflect.Type

type VlanInput

type VlanInput interface {
	pulumi.Input

	ToVlanOutput() VlanOutput
	ToVlanOutputWithContext(ctx context.Context) VlanOutput
}

type VlanMap

type VlanMap map[string]VlanInput

func (VlanMap) ElementType

func (VlanMap) ElementType() reflect.Type

func (VlanMap) ToVlanMapOutput

func (i VlanMap) ToVlanMapOutput() VlanMapOutput

func (VlanMap) ToVlanMapOutputWithContext

func (i VlanMap) ToVlanMapOutputWithContext(ctx context.Context) VlanMapOutput

type VlanMapInput

type VlanMapInput interface {
	pulumi.Input

	ToVlanMapOutput() VlanMapOutput
	ToVlanMapOutputWithContext(context.Context) VlanMapOutput
}

VlanMapInput is an input type that accepts VlanMap and VlanMapOutput values. You can construct a concrete instance of `VlanMapInput` via:

VlanMap{ "key": VlanArgs{...} }

type VlanMapOutput

type VlanMapOutput struct{ *pulumi.OutputState }

func (VlanMapOutput) ElementType

func (VlanMapOutput) ElementType() reflect.Type

func (VlanMapOutput) MapIndex

func (VlanMapOutput) ToVlanMapOutput

func (o VlanMapOutput) ToVlanMapOutput() VlanMapOutput

func (VlanMapOutput) ToVlanMapOutputWithContext

func (o VlanMapOutput) ToVlanMapOutputWithContext(ctx context.Context) VlanMapOutput

type VlanOutput

type VlanOutput struct{ *pulumi.OutputState }

func (VlanOutput) Description

func (o VlanOutput) Description() pulumi.StringPtrOutput

Defaults to `""`.

func (VlanOutput) ElementType

func (VlanOutput) ElementType() reflect.Type

func (VlanOutput) GroupId

func (o VlanOutput) GroupId() pulumi.IntPtrOutput

func (VlanOutput) Name

func (o VlanOutput) Name() pulumi.StringOutput

func (VlanOutput) RoleId

func (o VlanOutput) RoleId() pulumi.IntPtrOutput

func (VlanOutput) SiteId

func (o VlanOutput) SiteId() pulumi.IntPtrOutput

func (VlanOutput) Status

func (o VlanOutput) Status() pulumi.StringPtrOutput

Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.

func (VlanOutput) Tags

func (VlanOutput) TagsAlls

func (o VlanOutput) TagsAlls() pulumi.StringArrayOutput

func (VlanOutput) TenantId

func (o VlanOutput) TenantId() pulumi.IntPtrOutput

func (VlanOutput) ToVlanOutput

func (o VlanOutput) ToVlanOutput() VlanOutput

func (VlanOutput) ToVlanOutputWithContext

func (o VlanOutput) ToVlanOutputWithContext(ctx context.Context) VlanOutput

func (VlanOutput) Vid

func (o VlanOutput) Vid() pulumi.IntOutput

type VlanState

type VlanState struct {
	// Defaults to `""`.
	Description pulumi.StringPtrInput
	GroupId     pulumi.IntPtrInput
	Name        pulumi.StringPtrInput
	RoleId      pulumi.IntPtrInput
	SiteId      pulumi.IntPtrInput
	// Valid values are `active`, `reserved` and `deprecated`. Defaults to `active`.
	Status   pulumi.StringPtrInput
	Tags     pulumi.StringArrayInput
	TagsAlls pulumi.StringArrayInput
	TenantId pulumi.IntPtrInput
	Vid      pulumi.IntPtrInput
}

func (VlanState) ElementType

func (VlanState) ElementType() reflect.Type

type Vrf

type Vrf struct {
	pulumi.CustomResourceState

	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Defaults to `true`.
	EnforceUnique pulumi.BoolPtrOutput     `pulumi:"enforceUnique"`
	Name          pulumi.StringOutput      `pulumi:"name"`
	Rd            pulumi.StringPtrOutput   `pulumi:"rd"`
	Tags          pulumi.StringArrayOutput `pulumi:"tags"`
	TagsAlls      pulumi.StringArrayOutput `pulumi:"tagsAlls"`
	TenantId      pulumi.IntPtrOutput      `pulumi:"tenantId"`
}

From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#virtual-routing-and-forwarding-vrf):

> A VRF object in NetBox represents a virtual routing and forwarding (VRF) domain. Each VRF is essentially a separate routing table. VRFs are commonly used to isolate customers or organizations from one another within a network, or to route overlapping address space (e.g. multiple instances of the 10.0.0.0/8 space). Each VRF may be assigned to a specific tenant to aid in organizing the available IP space by customer or internal user.

## Example Usage

```go package main

import (

"github.com/NatzkaLabsOpenSource/pulumi-netbox/sdk/go/netbox/ipam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ipam.NewVrf(ctx, "cust_a_prod", &ipam.VrfArgs{
			Name: pulumi.String("cust-a-prod"),
			Tags: pulumi.StringArray{
				pulumi.String("customer-a"),
				pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetVrf

func GetVrf(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VrfState, opts ...pulumi.ResourceOption) (*Vrf, error)

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).

func NewVrf

func NewVrf(ctx *pulumi.Context,
	name string, args *VrfArgs, opts ...pulumi.ResourceOption) (*Vrf, error)

NewVrf registers a new resource with the given unique name, arguments, and options.

func (*Vrf) ElementType

func (*Vrf) ElementType() reflect.Type

func (*Vrf) ToVrfOutput

func (i *Vrf) ToVrfOutput() VrfOutput

func (*Vrf) ToVrfOutputWithContext

func (i *Vrf) ToVrfOutputWithContext(ctx context.Context) VrfOutput

type VrfArgs

type VrfArgs struct {
	Description pulumi.StringPtrInput
	// Defaults to `true`.
	EnforceUnique pulumi.BoolPtrInput
	Name          pulumi.StringPtrInput
	Rd            pulumi.StringPtrInput
	Tags          pulumi.StringArrayInput
	TenantId      pulumi.IntPtrInput
}

The set of arguments for constructing a Vrf resource.

func (VrfArgs) ElementType

func (VrfArgs) ElementType() reflect.Type

type VrfArray

type VrfArray []VrfInput

func (VrfArray) ElementType

func (VrfArray) ElementType() reflect.Type

func (VrfArray) ToVrfArrayOutput

func (i VrfArray) ToVrfArrayOutput() VrfArrayOutput

func (VrfArray) ToVrfArrayOutputWithContext

func (i VrfArray) ToVrfArrayOutputWithContext(ctx context.Context) VrfArrayOutput

type VrfArrayInput

type VrfArrayInput interface {
	pulumi.Input

	ToVrfArrayOutput() VrfArrayOutput
	ToVrfArrayOutputWithContext(context.Context) VrfArrayOutput
}

VrfArrayInput is an input type that accepts VrfArray and VrfArrayOutput values. You can construct a concrete instance of `VrfArrayInput` via:

VrfArray{ VrfArgs{...} }

type VrfArrayOutput

type VrfArrayOutput struct{ *pulumi.OutputState }

func (VrfArrayOutput) ElementType

func (VrfArrayOutput) ElementType() reflect.Type

func (VrfArrayOutput) Index

func (VrfArrayOutput) ToVrfArrayOutput

func (o VrfArrayOutput) ToVrfArrayOutput() VrfArrayOutput

func (VrfArrayOutput) ToVrfArrayOutputWithContext

func (o VrfArrayOutput) ToVrfArrayOutputWithContext(ctx context.Context) VrfArrayOutput

type VrfInput

type VrfInput interface {
	pulumi.Input

	ToVrfOutput() VrfOutput
	ToVrfOutputWithContext(ctx context.Context) VrfOutput
}

type VrfMap

type VrfMap map[string]VrfInput

func (VrfMap) ElementType

func (VrfMap) ElementType() reflect.Type

func (VrfMap) ToVrfMapOutput

func (i VrfMap) ToVrfMapOutput() VrfMapOutput

func (VrfMap) ToVrfMapOutputWithContext

func (i VrfMap) ToVrfMapOutputWithContext(ctx context.Context) VrfMapOutput

type VrfMapInput

type VrfMapInput interface {
	pulumi.Input

	ToVrfMapOutput() VrfMapOutput
	ToVrfMapOutputWithContext(context.Context) VrfMapOutput
}

VrfMapInput is an input type that accepts VrfMap and VrfMapOutput values. You can construct a concrete instance of `VrfMapInput` via:

VrfMap{ "key": VrfArgs{...} }

type VrfMapOutput

type VrfMapOutput struct{ *pulumi.OutputState }

func (VrfMapOutput) ElementType

func (VrfMapOutput) ElementType() reflect.Type

func (VrfMapOutput) MapIndex

func (o VrfMapOutput) MapIndex(k pulumi.StringInput) VrfOutput

func (VrfMapOutput) ToVrfMapOutput

func (o VrfMapOutput) ToVrfMapOutput() VrfMapOutput

func (VrfMapOutput) ToVrfMapOutputWithContext

func (o VrfMapOutput) ToVrfMapOutputWithContext(ctx context.Context) VrfMapOutput

type VrfOutput

type VrfOutput struct{ *pulumi.OutputState }

func (VrfOutput) Description

func (o VrfOutput) Description() pulumi.StringPtrOutput

func (VrfOutput) ElementType

func (VrfOutput) ElementType() reflect.Type

func (VrfOutput) EnforceUnique

func (o VrfOutput) EnforceUnique() pulumi.BoolPtrOutput

Defaults to `true`.

func (VrfOutput) Name

func (o VrfOutput) Name() pulumi.StringOutput

func (VrfOutput) Rd

func (VrfOutput) Tags

func (VrfOutput) TagsAlls

func (o VrfOutput) TagsAlls() pulumi.StringArrayOutput

func (VrfOutput) TenantId

func (o VrfOutput) TenantId() pulumi.IntPtrOutput

func (VrfOutput) ToVrfOutput

func (o VrfOutput) ToVrfOutput() VrfOutput

func (VrfOutput) ToVrfOutputWithContext

func (o VrfOutput) ToVrfOutputWithContext(ctx context.Context) VrfOutput

type VrfState

type VrfState struct {
	Description pulumi.StringPtrInput
	// Defaults to `true`.
	EnforceUnique pulumi.BoolPtrInput
	Name          pulumi.StringPtrInput
	Rd            pulumi.StringPtrInput
	Tags          pulumi.StringArrayInput
	TagsAlls      pulumi.StringArrayInput
	TenantId      pulumi.IntPtrInput
}

func (VrfState) ElementType

func (VrfState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL