@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
127 lines (126 loc) • 5.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/dcim/consoleserverport/):
*
* > A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices, and generally connect to console ports.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* // Note that some terraform code is not included in the example for brevity
* const test = new netbox.dcim.Device("test", {
* name: "%[1]s",
* deviceTypeId: testNetboxDeviceType.id,
* roleId: testNetboxDeviceRole.id,
* siteId: testNetboxSite.id,
* });
* const testDeviceConsoleServerPort = new netbox.dcim.DeviceConsoleServerPort("test", {
* deviceId: test.id,
* name: "console server port",
* type: "de-9",
* speed: 1200,
* markConnected: true,
* });
* ```
*/
export declare class DeviceConsoleServerPort extends pulumi.CustomResource {
/**
* Get an existing DeviceConsoleServerPort 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?: DeviceConsoleServerPortState, opts?: pulumi.CustomResourceOptions): DeviceConsoleServerPort;
/**
* Returns true if the given object is an instance of DeviceConsoleServerPort. 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 DeviceConsoleServerPort;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly deviceId: pulumi.Output<number>;
readonly label: pulumi.Output<string | undefined>;
/**
* Defaults to `false`.
*/
readonly markConnected: pulumi.Output<boolean | undefined>;
readonly moduleId: pulumi.Output<number | undefined>;
readonly name: pulumi.Output<string>;
/**
* One of [1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200].
*/
readonly speed: pulumi.Output<number | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* One of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other].
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a DeviceConsoleServerPort 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: DeviceConsoleServerPortArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DeviceConsoleServerPort resources.
*/
export interface DeviceConsoleServerPortState {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
deviceId?: pulumi.Input<number>;
label?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
markConnected?: pulumi.Input<boolean>;
moduleId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
/**
* One of [1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200].
*/
speed?: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* One of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other].
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DeviceConsoleServerPort resource.
*/
export interface DeviceConsoleServerPortArgs {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
deviceId: pulumi.Input<number>;
label?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
markConnected?: pulumi.Input<boolean>;
moduleId?: pulumi.Input<number>;
name?: pulumi.Input<string>;
/**
* One of [1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200].
*/
speed?: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* One of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other].
*/
type?: pulumi.Input<string>;
}