@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
80 lines (79 loc) • 3.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Per [the docs](https://netbox.readthedocs.io/en/stable/models/ipam/vlan/):
*
* > A VLAN represents an isolated Layer 2 domain identified by a numeric ID (1–4094). VLANs may be assigned to specific sites or marked as global.
* Optionally, they can be organized within VLAN groups to define scope and enforce uniqueness.
* >
* > Each VLAN can also be assigned an operational status and a functional role. Statuses are hard-coded in NetBox and include the following:
* > * Active
* > * Reserved
* > * Deprecated
*
* This resource will retrieve the next available VLAN ID from a given VLAN group (specified by ID).
*/
export declare class AvailableVlan extends pulumi.CustomResource {
/**
* Get an existing AvailableVlan 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?: AvailableVlanState, opts?: pulumi.CustomResourceOptions): AvailableVlan;
/**
* Returns true if the given object is an instance of AvailableVlan. 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 AvailableVlan;
readonly comments: pulumi.Output<string>;
readonly description: pulumi.Output<string | undefined>;
readonly groupId: pulumi.Output<number | undefined>;
readonly name: pulumi.Output<string>;
readonly roleId: pulumi.Output<number | undefined>;
readonly siteId: pulumi.Output<number | undefined>;
readonly status: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tagsAlls: pulumi.Output<string[]>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly vid: pulumi.Output<number>;
/**
* Create a AvailableVlan 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?: AvailableVlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AvailableVlan resources.
*/
export interface AvailableVlanState {
comments?: pulumi.Input<string>;
description?: pulumi.Input<string>;
groupId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
roleId?: pulumi.Input<number>;
siteId?: pulumi.Input<number>;
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tagsAlls?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
vid?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a AvailableVlan resource.
*/
export interface AvailableVlanArgs {
description?: pulumi.Input<string>;
groupId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
roleId?: pulumi.Input<number>;
siteId?: pulumi.Input<number>;
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
}