UNPKG

@natzka-oss/pulumi-netbox

Version:

A Pulumi package for creating and managing Netbox cloud resources.

79 lines (78 loc) 3.36 kB
import * as pulumi from "@pulumi/pulumi"; /** * From the [official documentation](https://docs.netbox.dev/en/stable/features/devices-cabling/#virtual-chassis): * * > Sometimes it is necessary to model a set of physical devices as sharing a single management plane. Perhaps the most common example of such a scenario is stackable switches. These can be modeled as virtual chassis in NetBox, with one device acting as the chassis master and the rest as members. All components of member devices will appear on the master. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as netbox from "@natzka-oss/pulumi-netbox"; * * const example = new netbox.dcim.VirtualChassis("example", { * name: "chassis", * domain: "domain", * description: "virtual chassis", * }); * ``` */ export declare class VirtualChassis extends pulumi.CustomResource { /** * Get an existing VirtualChassis 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?: VirtualChassisState, opts?: pulumi.CustomResourceOptions): VirtualChassis; /** * Returns true if the given object is an instance of VirtualChassis. 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 VirtualChassis; readonly comments: pulumi.Output<string | undefined>; readonly customFields: pulumi.Output<{ [key: string]: string; } | undefined>; readonly description: pulumi.Output<string | undefined>; readonly domain: pulumi.Output<string | undefined>; readonly name: pulumi.Output<string>; readonly tags: pulumi.Output<string[] | undefined>; /** * Create a VirtualChassis 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?: VirtualChassisArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VirtualChassis resources. */ export interface VirtualChassisState { comments?: pulumi.Input<string>; customFields?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; description?: pulumi.Input<string>; domain?: pulumi.Input<string>; name?: pulumi.Input<string>; tags?: pulumi.Input<pulumi.Input<string>[]>; } /** * The set of arguments for constructing a VirtualChassis resource. */ export interface VirtualChassisArgs { comments?: pulumi.Input<string>; customFields?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; description?: pulumi.Input<string>; domain?: pulumi.Input<string>; name?: pulumi.Input<string>; tags?: pulumi.Input<pulumi.Input<string>[]>; }