@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
424 lines (423 loc) • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource manages the Wireless Access Point configuration.
*
* It can be used to define specific configuration at the device level or to override AP Device Profile (`junipermist.org.DeviceprofileAp`).
*
* ## Import
*
* Using `pulumi import`, import `mist_device_ap` with:
*
* AP Configuration can be imported by specifying the site_id and the device_id
*
* ```sh
* $ pulumi import junipermist:device/ap:Ap ap_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class Ap extends pulumi.CustomResource {
/**
* Get an existing Ap 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?: ApState, opts?: pulumi.CustomResourceOptions): Ap;
/**
* Returns true if the given object is an instance of Ap. 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 Ap;
/**
* Aeroscout AP settings
*/
readonly aeroscout: pulumi.Output<outputs.device.ApAeroscout | undefined>;
/**
* BLE AP settings
*/
readonly bleConfig: pulumi.Output<outputs.device.ApBleConfig | undefined>;
readonly centrak: pulumi.Output<outputs.device.ApCentrak | undefined>;
readonly clientBridge: pulumi.Output<outputs.device.ApClientBridge | undefined>;
readonly deviceId: pulumi.Output<string>;
/**
* Whether to disable eth1 port
*/
readonly disableEth1: pulumi.Output<boolean>;
/**
* Whether to disable eth2 port
*/
readonly disableEth2: pulumi.Output<boolean>;
/**
* Whether to disable eth3 port
*/
readonly disableEth3: pulumi.Output<boolean>;
/**
* Whether to disable module port
*/
readonly disableModule: pulumi.Output<boolean>;
readonly eslConfig: pulumi.Output<outputs.device.ApEslConfig | undefined>;
/**
* For some AP models, flowControl can be enabled to address some switch compatibility issue
*/
readonly flowControl: pulumi.Output<boolean>;
/**
* Height, in meters, optional
*/
readonly height: pulumi.Output<number | undefined>;
readonly image1Url: pulumi.Output<string>;
readonly image2Url: pulumi.Output<string>;
readonly image3Url: pulumi.Output<string>;
/**
* IP AP settings
*/
readonly ipConfig: pulumi.Output<outputs.device.ApIpConfig | undefined>;
readonly lacpConfig: pulumi.Output<outputs.device.ApLacpConfig | undefined>;
/**
* LED AP settings
*/
readonly led: pulumi.Output<outputs.device.ApLed | undefined>;
/**
* Whether this map is considered locked down
*/
readonly locked: pulumi.Output<boolean | undefined>;
/**
* Device MAC address
*/
readonly mac: pulumi.Output<string>;
/**
* Map where the device belongs to
*/
readonly mapId: pulumi.Output<string | undefined>;
/**
* Mesh AP settings
*/
readonly mesh: pulumi.Output<outputs.device.ApMesh | undefined>;
/**
* Device Model
*/
readonly model: pulumi.Output<string>;
readonly name: pulumi.Output<string>;
/**
* Any notes about this AP
*/
readonly notes: pulumi.Output<string | undefined>;
readonly ntpServers: pulumi.Output<string[] | undefined>;
readonly orgId: pulumi.Output<string>;
/**
* Orientation, 0-359, in degrees, up is 0, right is 90.
*/
readonly orientation: pulumi.Output<number | undefined>;
/**
* Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
*/
readonly poePassthrough: pulumi.Output<boolean>;
/**
* eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If specified, this takes
* precedence over switchConfig (deprecated)
*/
readonly portConfig: pulumi.Output<{
[key: string]: outputs.device.ApPortConfig;
} | undefined>;
/**
* Power related configs
*/
readonly pwrConfig: pulumi.Output<outputs.device.ApPwrConfig | undefined>;
/**
* Radio AP settings
*/
readonly radioConfig: pulumi.Output<outputs.device.ApRadioConfig | undefined>;
/**
* Device Serial
*/
readonly serial: pulumi.Output<string>;
readonly siteId: pulumi.Output<string>;
/**
* Device Type. enum: `ap`
*/
readonly type: pulumi.Output<string>;
/**
* AP Uplink port configuration
*/
readonly uplinkPortConfig: pulumi.Output<outputs.device.ApUplinkPortConfig | undefined>;
/**
* USB AP settings - Note: if native imagotag is enabled, BLE will be disabled automatically - Note: legacy, new config
* moved to ESL Config.
*/
readonly usbConfig: pulumi.Output<outputs.device.ApUsbConfig | undefined>;
/**
* Dictionary of name->value, the vars can then be used in Wlans. This can overwrite those from Site Vars
*/
readonly vars: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* X in pixel
*/
readonly x: pulumi.Output<number | undefined>;
/**
* Y in pixel
*/
readonly y: pulumi.Output<number | undefined>;
/**
* Create a Ap 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: ApArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ap resources.
*/
export interface ApState {
/**
* Aeroscout AP settings
*/
aeroscout?: pulumi.Input<inputs.device.ApAeroscout>;
/**
* BLE AP settings
*/
bleConfig?: pulumi.Input<inputs.device.ApBleConfig>;
centrak?: pulumi.Input<inputs.device.ApCentrak>;
clientBridge?: pulumi.Input<inputs.device.ApClientBridge>;
deviceId?: pulumi.Input<string>;
/**
* Whether to disable eth1 port
*/
disableEth1?: pulumi.Input<boolean>;
/**
* Whether to disable eth2 port
*/
disableEth2?: pulumi.Input<boolean>;
/**
* Whether to disable eth3 port
*/
disableEth3?: pulumi.Input<boolean>;
/**
* Whether to disable module port
*/
disableModule?: pulumi.Input<boolean>;
eslConfig?: pulumi.Input<inputs.device.ApEslConfig>;
/**
* For some AP models, flowControl can be enabled to address some switch compatibility issue
*/
flowControl?: pulumi.Input<boolean>;
/**
* Height, in meters, optional
*/
height?: pulumi.Input<number>;
image1Url?: pulumi.Input<string>;
image2Url?: pulumi.Input<string>;
image3Url?: pulumi.Input<string>;
/**
* IP AP settings
*/
ipConfig?: pulumi.Input<inputs.device.ApIpConfig>;
lacpConfig?: pulumi.Input<inputs.device.ApLacpConfig>;
/**
* LED AP settings
*/
led?: pulumi.Input<inputs.device.ApLed>;
/**
* Whether this map is considered locked down
*/
locked?: pulumi.Input<boolean>;
/**
* Device MAC address
*/
mac?: pulumi.Input<string>;
/**
* Map where the device belongs to
*/
mapId?: pulumi.Input<string>;
/**
* Mesh AP settings
*/
mesh?: pulumi.Input<inputs.device.ApMesh>;
/**
* Device Model
*/
model?: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* Any notes about this AP
*/
notes?: pulumi.Input<string>;
ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
orgId?: pulumi.Input<string>;
/**
* Orientation, 0-359, in degrees, up is 0, right is 90.
*/
orientation?: pulumi.Input<number>;
/**
* Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
*/
poePassthrough?: pulumi.Input<boolean>;
/**
* eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If specified, this takes
* precedence over switchConfig (deprecated)
*/
portConfig?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.device.ApPortConfig>;
}>;
/**
* Power related configs
*/
pwrConfig?: pulumi.Input<inputs.device.ApPwrConfig>;
/**
* Radio AP settings
*/
radioConfig?: pulumi.Input<inputs.device.ApRadioConfig>;
/**
* Device Serial
*/
serial?: pulumi.Input<string>;
siteId?: pulumi.Input<string>;
/**
* Device Type. enum: `ap`
*/
type?: pulumi.Input<string>;
/**
* AP Uplink port configuration
*/
uplinkPortConfig?: pulumi.Input<inputs.device.ApUplinkPortConfig>;
/**
* USB AP settings - Note: if native imagotag is enabled, BLE will be disabled automatically - Note: legacy, new config
* moved to ESL Config.
*/
usbConfig?: pulumi.Input<inputs.device.ApUsbConfig>;
/**
* Dictionary of name->value, the vars can then be used in Wlans. This can overwrite those from Site Vars
*/
vars?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* X in pixel
*/
x?: pulumi.Input<number>;
/**
* Y in pixel
*/
y?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Ap resource.
*/
export interface ApArgs {
/**
* Aeroscout AP settings
*/
aeroscout?: pulumi.Input<inputs.device.ApAeroscout>;
/**
* BLE AP settings
*/
bleConfig?: pulumi.Input<inputs.device.ApBleConfig>;
centrak?: pulumi.Input<inputs.device.ApCentrak>;
clientBridge?: pulumi.Input<inputs.device.ApClientBridge>;
deviceId: pulumi.Input<string>;
/**
* Whether to disable eth1 port
*/
disableEth1?: pulumi.Input<boolean>;
/**
* Whether to disable eth2 port
*/
disableEth2?: pulumi.Input<boolean>;
/**
* Whether to disable eth3 port
*/
disableEth3?: pulumi.Input<boolean>;
/**
* Whether to disable module port
*/
disableModule?: pulumi.Input<boolean>;
eslConfig?: pulumi.Input<inputs.device.ApEslConfig>;
/**
* For some AP models, flowControl can be enabled to address some switch compatibility issue
*/
flowControl?: pulumi.Input<boolean>;
/**
* Height, in meters, optional
*/
height?: pulumi.Input<number>;
/**
* IP AP settings
*/
ipConfig?: pulumi.Input<inputs.device.ApIpConfig>;
lacpConfig?: pulumi.Input<inputs.device.ApLacpConfig>;
/**
* LED AP settings
*/
led?: pulumi.Input<inputs.device.ApLed>;
/**
* Whether this map is considered locked down
*/
locked?: pulumi.Input<boolean>;
/**
* Map where the device belongs to
*/
mapId?: pulumi.Input<string>;
/**
* Mesh AP settings
*/
mesh?: pulumi.Input<inputs.device.ApMesh>;
name?: pulumi.Input<string>;
/**
* Any notes about this AP
*/
notes?: pulumi.Input<string>;
ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Orientation, 0-359, in degrees, up is 0, right is 90.
*/
orientation?: pulumi.Input<number>;
/**
* Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
*/
poePassthrough?: pulumi.Input<boolean>;
/**
* eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If specified, this takes
* precedence over switchConfig (deprecated)
*/
portConfig?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.device.ApPortConfig>;
}>;
/**
* Power related configs
*/
pwrConfig?: pulumi.Input<inputs.device.ApPwrConfig>;
/**
* Radio AP settings
*/
radioConfig?: pulumi.Input<inputs.device.ApRadioConfig>;
siteId: pulumi.Input<string>;
/**
* AP Uplink port configuration
*/
uplinkPortConfig?: pulumi.Input<inputs.device.ApUplinkPortConfig>;
/**
* USB AP settings - Note: if native imagotag is enabled, BLE will be disabled automatically - Note: legacy, new config
* moved to ESL Config.
*/
usbConfig?: pulumi.Input<inputs.device.ApUsbConfig>;
/**
* Dictionary of name->value, the vars can then be used in Wlans. This can overwrite those from Site Vars
*/
vars?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* X in pixel
*/
x?: pulumi.Input<number>;
/**
* Y in pixel
*/
y?: pulumi.Input<number>;
}