pulumi-netbox/ipAddress.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/ipam/#ip-addresses):
 *
 * > An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world.
 * >
 * > Like a prefix, an IP address can optionally be assigned to a VRF (otherwise, it will appear in the "global" table). IP addresses are automatically arranged under parent prefixes within their respective VRFs according to the IP hierarchy.
 */
export declare class IpAddress extends pulumi.CustomResource {
    /**
     * Get an existing IpAddress 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?: IpAddressState, opts?: pulumi.CustomResourceOptions): IpAddress;
    /**
     * Returns true if the given object is an instance of IpAddress.  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 IpAddress;
    readonly description: pulumi.Output<string | undefined>;
    readonly dnsName: pulumi.Output<string | undefined>;
    readonly interfaceId: pulumi.Output<number | undefined>;
    readonly ipAddress: pulumi.Output<string>;
    readonly status: pulumi.Output<string>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tenantId: pulumi.Output<number | undefined>;
    readonly vrfId: pulumi.Output<number | undefined>;
    /**
     * Create a IpAddress 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: IpAddressArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IpAddress resources.
 */
export interface IpAddressState {
    description?: pulumi.Input<string>;
    dnsName?: pulumi.Input<string>;
    interfaceId?: pulumi.Input<number>;
    ipAddress?: pulumi.Input<string>;
    status?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
    vrfId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a IpAddress resource.
 */
export interface IpAddressArgs {
    description?: pulumi.Input<string>;
    dnsName?: pulumi.Input<string>;
    interfaceId?: pulumi.Input<number>;
    ipAddress: pulumi.Input<string>;
    status: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
    vrfId?: pulumi.Input<number>;
}