pulumi-netbox/device.d.ts

A Pulumi package for creating and managing Netbox resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * From the [official documentation](https://docs.netbox.dev/en/stable/core-functionality/devices/#devices):
 *
 * > Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth or full depth. A device may have a height of 0U: These devices do not consume vertical rack space and cannot be assigned to a particular rack unit. A common example of a 0U device is a vertically-mounted PDU.
 */
export declare class Device extends pulumi.CustomResource {
    /**
     * Get an existing Device 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?: DeviceState, opts?: pulumi.CustomResourceOptions): Device;
    /**
     * Returns true if the given object is an instance of Device.  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 Device;
    readonly comments: pulumi.Output<string | undefined>;
    readonly deviceTypeId: pulumi.Output<number>;
    readonly name: pulumi.Output<string>;
    readonly primaryIpv4: pulumi.Output<number>;
    readonly roleId: pulumi.Output<number | undefined>;
    readonly serial: pulumi.Output<string | undefined>;
    readonly siteId: pulumi.Output<number | undefined>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tenantId: pulumi.Output<number | undefined>;
    /**
     * Create a Device 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: DeviceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Device resources.
 */
export interface DeviceState {
    comments?: pulumi.Input<string>;
    deviceTypeId?: pulumi.Input<number>;
    name?: pulumi.Input<string>;
    primaryIpv4?: pulumi.Input<number>;
    roleId?: pulumi.Input<number>;
    serial?: pulumi.Input<string>;
    siteId?: pulumi.Input<number>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Device resource.
 */
export interface DeviceArgs {
    comments?: pulumi.Input<string>;
    deviceTypeId: pulumi.Input<number>;
    name?: pulumi.Input<string>;
    roleId?: pulumi.Input<number>;
    serial?: pulumi.Input<string>;
    siteId?: pulumi.Input<number>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}