@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
107 lines (106 loc) • 4.78 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/sites-and-racks/#sites):
*
* > How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a building or campus. For example, a chain of banks might create a site to represent each of its branches, a site for its corporate headquarters, and two additional sites for its presence in two colocation facilities.
* >
* > Each site must be assigned a unique name and may optionally be assigned to a region and/or tenant.
*/
export declare class Site extends pulumi.CustomResource {
/**
* Get an existing Site 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?: SiteState, opts?: pulumi.CustomResourceOptions): Site;
/**
* Returns true if the given object is an instance of Site. 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 Site;
readonly asnIds: pulumi.Output<number[] | undefined>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly facility: pulumi.Output<string | undefined>;
readonly groupId: pulumi.Output<number | undefined>;
readonly latitude: pulumi.Output<number | undefined>;
readonly longitude: pulumi.Output<number | undefined>;
readonly name: pulumi.Output<string>;
readonly physicalAddress: pulumi.Output<string | undefined>;
readonly regionId: pulumi.Output<number | undefined>;
readonly shippingAddress: pulumi.Output<string | undefined>;
readonly slug: pulumi.Output<string>;
/**
* Valid values are `planned`, `staging`, `active`, `decommissioning` and `retired`. Defaults to `active`.
*/
readonly status: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly timezone: pulumi.Output<string | undefined>;
/**
* Create a Site 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?: SiteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Site resources.
*/
export interface SiteState {
asnIds?: pulumi.Input<pulumi.Input<number>[]>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
facility?: pulumi.Input<string>;
groupId?: pulumi.Input<number>;
latitude?: pulumi.Input<number>;
longitude?: pulumi.Input<number>;
name?: pulumi.Input<string>;
physicalAddress?: pulumi.Input<string>;
regionId?: pulumi.Input<number>;
shippingAddress?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
/**
* Valid values are `planned`, `staging`, `active`, `decommissioning` and `retired`. Defaults to `active`.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Site resource.
*/
export interface SiteArgs {
asnIds?: pulumi.Input<pulumi.Input<number>[]>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
facility?: pulumi.Input<string>;
groupId?: pulumi.Input<number>;
latitude?: pulumi.Input<number>;
longitude?: pulumi.Input<number>;
name?: pulumi.Input<string>;
physicalAddress?: pulumi.Input<string>;
regionId?: pulumi.Input<number>;
shippingAddress?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
/**
* Valid values are `planned`, `staging`, `active`, `decommissioning` and `retired`. Defaults to `active`.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
}