@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
82 lines (81 loc) • 3.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource is used to define the primary IP for a given device. The primary IP is reflected in the device Netbox UI, which identifies the Primary IPv4 and IPv6 addresses.
*
* ## 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 testV4 = new netbox.ipam.IpAddress("test_v4", {
* ipAddress: "1.1.1.1/32",
* status: "active",
* deviceInterfaceId: testNetboxDeviceInterface.id,
* });
* const testV4DevicePrimaryIp = new netbox.dcim.DevicePrimaryIp("test_v4", {
* deviceId: test.id,
* ipAddressId: testNetboxIpAddress.id,
* });
* ```
*/
export declare class DevicePrimaryIp extends pulumi.CustomResource {
/**
* Get an existing DevicePrimaryIp 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?: DevicePrimaryIpState, opts?: pulumi.CustomResourceOptions): DevicePrimaryIp;
/**
* Returns true if the given object is an instance of DevicePrimaryIp. 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 DevicePrimaryIp;
readonly deviceId: pulumi.Output<number>;
readonly ipAddressId: pulumi.Output<number>;
/**
* Defaults to `4`.
*/
readonly ipAddressVersion: pulumi.Output<number | undefined>;
/**
* Create a DevicePrimaryIp 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: DevicePrimaryIpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DevicePrimaryIp resources.
*/
export interface DevicePrimaryIpState {
deviceId?: pulumi.Input<number>;
ipAddressId?: pulumi.Input<number>;
/**
* Defaults to `4`.
*/
ipAddressVersion?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a DevicePrimaryIp resource.
*/
export interface DevicePrimaryIpArgs {
deviceId: pulumi.Input<number>;
ipAddressId: pulumi.Input<number>;
/**
* Defaults to `4`.
*/
ipAddressVersion?: pulumi.Input<number>;
}