@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
90 lines (89 loc) • 3.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/dcim/powerpanel/):
*
* > A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one power panel often serves a group of racks, with an individual power feed extending to each rack, though this is not always the case. It is common to have two sets of panels and feeds arranged in parallel to provide redundant power to each rack.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.dcim.Site("test", {
* name: "Site 1",
* status: "active",
* });
* const testLocation = new netbox.dcim.Location("test", {
* name: "Location 1",
* siteId: test.id,
* });
* const testPowerPanel = new netbox.dcim.PowerPanel("test", {
* name: "Power Panel 1",
* siteId: test.id,
* locationId: testLocation.id,
* });
* ```
*/
export declare class PowerPanel extends pulumi.CustomResource {
/**
* Get an existing PowerPanel 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?: PowerPanelState, opts?: pulumi.CustomResourceOptions): PowerPanel;
/**
* Returns true if the given object is an instance of PowerPanel. 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 PowerPanel;
readonly comments: pulumi.Output<string | undefined>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly locationId: pulumi.Output<number | undefined>;
readonly name: pulumi.Output<string>;
readonly siteId: pulumi.Output<number>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a PowerPanel 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: PowerPanelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PowerPanel resources.
*/
export interface PowerPanelState {
comments?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
locationId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
siteId?: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a PowerPanel resource.
*/
export interface PowerPanelArgs {
comments?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
locationId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
siteId: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}