@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
87 lines (86 loc) • 2.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## 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,
* });
* ```
*/
export declare function getVlan(args?: GetVlanArgs, opts?: pulumi.InvokeOptions): Promise<GetVlanResult>;
/**
* A collection of arguments for invoking getVlan.
*/
export interface GetVlanArgs {
groupId?: number;
name?: string;
role?: number;
tenant?: number;
vid?: number;
}
/**
* A collection of values returned by getVlan.
*/
export interface GetVlanResult {
readonly description: string;
readonly groupId: number;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name?: string;
readonly role: number;
readonly site: number;
readonly status: string;
readonly tenant: number;
readonly vid?: number;
}
/**
* ## 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,
* });
* ```
*/
export declare function getVlanOutput(args?: GetVlanOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVlanResult>;
/**
* A collection of arguments for invoking getVlan.
*/
export interface GetVlanOutputArgs {
groupId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
role?: pulumi.Input<number>;
tenant?: pulumi.Input<number>;
vid?: pulumi.Input<number>;
}