@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
108 lines (107 loc) • 4.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#prefixes):
*
* > A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: All bits in the address not covered by the mask must be zero. (In other words, a prefix cannot be a specific IP address.)
* >
* > Prefixes are automatically organized by their parent aggregates. Additionally, each prefix can be assigned to a particular site and virtual routing and forwarding instance (VRF). Each VRF represents a separate IP space or routing table. All prefixes not assigned to a VRF are considered to be in the "global" table.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const myPrefix = new netbox.ipam.Prefix("my_prefix", {
* prefix: "10.0.0.0/24",
* status: "active",
* description: "test prefix",
* });
* ```
*/
export declare class Prefix extends pulumi.CustomResource {
/**
* Get an existing Prefix 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?: PrefixState, opts?: pulumi.CustomResourceOptions): Prefix;
/**
* Returns true if the given object is an instance of Prefix. 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 Prefix;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly isPool: pulumi.Output<boolean | undefined>;
readonly markUtilized: pulumi.Output<boolean | undefined>;
readonly prefix: pulumi.Output<string>;
readonly roleId: pulumi.Output<number | undefined>;
readonly siteId: pulumi.Output<number | undefined>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
readonly status: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly vlanId: pulumi.Output<number | undefined>;
readonly vrfId: pulumi.Output<number | undefined>;
/**
* Create a Prefix 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: PrefixArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Prefix resources.
*/
export interface PrefixState {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
isPool?: pulumi.Input<boolean>;
markUtilized?: pulumi.Input<boolean>;
prefix?: pulumi.Input<string>;
roleId?: pulumi.Input<number>;
siteId?: pulumi.Input<number>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
vlanId?: pulumi.Input<number>;
vrfId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Prefix resource.
*/
export interface PrefixArgs {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
isPool?: pulumi.Input<boolean>;
markUtilized?: pulumi.Input<boolean>;
prefix: pulumi.Input<string>;
roleId?: pulumi.Input<number>;
siteId?: pulumi.Input<number>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
status: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
vlanId?: pulumi.Input<number>;
vrfId?: pulumi.Input<number>;
}