@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
120 lines (119 loc) • 4.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* //Basic VLAN Group example
* const example1 = new netbox.ipam.VlanGroup("example1", {
* name: "example1",
* slug: "example1",
* });
* //Full VLAN Group example
* const example2 = new netbox.ipam.VlanGroup("example2", {
* name: "Second Example",
* slug: "example2",
* scopeType: "dcim.site",
* scopeId: example.id,
* description: "Second Example VLAN Group",
* tags: [exampleNetboxTag.id],
* vidRanges: [
* [
* 1,
* 2,
* ],
* [
* 3,
* 4,
* ],
* ],
* });
* ```
*/
export declare class VlanGroup extends pulumi.CustomResource {
/**
* Get an existing VlanGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VlanGroupState, opts?: pulumi.CustomResourceOptions): VlanGroup;
/**
* Returns true if the given object is an instance of VlanGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VlanGroup;
/**
* Defaults to `""`.
*/
readonly description: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
/**
* Required when `scopeType` is set.
*/
readonly scopeId: pulumi.Output<number | undefined>;
/**
* Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
*/
readonly scopeType: pulumi.Output<string | undefined>;
readonly slug: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly vidRanges: pulumi.Output<number[][]>;
/**
* Create a VlanGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VlanGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VlanGroup resources.
*/
export interface VlanGroupState {
/**
* Defaults to `""`.
*/
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* Required when `scopeType` is set.
*/
scopeId?: pulumi.Input<number>;
/**
* Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
*/
scopeType?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
vidRanges?: pulumi.Input<pulumi.Input<pulumi.Input<number>[]>[]>;
}
/**
* The set of arguments for constructing a VlanGroup resource.
*/
export interface VlanGroupArgs {
/**
* Defaults to `""`.
*/
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* Required when `scopeType` is set.
*/
scopeId?: pulumi.Input<number>;
/**
* Valid values are `dcim.location`, `dcim.site`, `dcim.sitegroup`, `dcim.region`, `dcim.rack`, `virtualization.cluster` and `virtualization.clustergroup`.
*/
scopeType?: pulumi.Input<string>;
slug: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
vidRanges: pulumi.Input<pulumi.Input<pulumi.Input<number>[]>[]>;
}