@natzka-oss/pulumi-netbox/ipam/getVlan.js

A Pulumi package for creating and managing Netbox cloud resources.

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getVlanOutput = exports.getVlan = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@pulumi/netbox";
 *
 * // Get VLAN by name
 * const vlan1 = netbox.ipam.getVlan({
 *     name: "vlan-1",
 * });
 * // Get VLAN by VID and IPAM role ID
 * const vlan2 = netbox.ipam.getVlan({
 *     vid: 1234,
 *     role: example.id,
 * });
 * // Get VLAN by name and tenant ID
 * const vlan3 = netbox.ipam.getVlan({
 *     name: "vlan-3",
 *     tenant: exampleNetboxTenant.id,
 * });
 * ```
 */
function getVlan(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("netbox:ipam/getVlan:getVlan", {
        "groupId": args.groupId,
        "name": args.name,
        "role": args.role,
        "tenant": args.tenant,
        "vid": args.vid,
    }, opts);
}
exports.getVlan = getVlan;
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@pulumi/netbox";
 *
 * // Get VLAN by name
 * const vlan1 = netbox.ipam.getVlan({
 *     name: "vlan-1",
 * });
 * // Get VLAN by VID and IPAM role ID
 * const vlan2 = netbox.ipam.getVlan({
 *     vid: 1234,
 *     role: example.id,
 * });
 * // Get VLAN by name and tenant ID
 * const vlan3 = netbox.ipam.getVlan({
 *     name: "vlan-3",
 *     tenant: exampleNetboxTenant.id,
 * });
 * ```
 */
function getVlanOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("netbox:ipam/getVlan:getVlan", {
        "groupId": args.groupId,
        "name": args.name,
        "role": args.role,
        "tenant": args.tenant,
        "vid": args.vid,
    }, opts);
}
exports.getVlanOutput = getVlanOutput;
//# sourceMappingURL=getVlan.js.map