@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
308 lines (307 loc) • 10.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource manages the AP Device Profiles.
* AP Device profiles for aps are used to specify a configuration that can be applied to a select set of aps from any site in the organization. They allow for efficient application of configurations based on ap groups, wlan groups, RF settings, and sites. Device profiles enable various use cases such as activating ethernet passthrough, applying different rf settings, applying mesh configuration, activating specific features like esl or vble, and more.
*
* The AP Device Profile can be assigned to a gateway with the `junipermist.org.DeviceprofileAssign` resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const deviceprofileApOne = new junipermist.org.DeviceprofileAp("deviceprofile_ap_one", {
* name: "deviceprofile_ap_one",
* orgId: terraformTest.id,
* eslConfig: {
* enabled: true,
* host: "1.2.3.4",
* type: "native",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `mist_org_deviceprofile_ap` with:
*
* Device Profile can be imported by specifying the org_id and the deviceprofile_id
*
* ```sh
* $ pulumi import junipermist:org/deviceprofileAp:DeviceprofileAp deviceprofile_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class DeviceprofileAp extends pulumi.CustomResource {
/**
* Get an existing DeviceprofileAp 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?: DeviceprofileApState, opts?: pulumi.CustomResourceOptions): DeviceprofileAp;
/**
* Returns true if the given object is an instance of DeviceprofileAp. 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 DeviceprofileAp;
/**
* Aeroscout AP settings
*/
readonly aeroscout: pulumi.Output<outputs.org.DeviceprofileApAeroscout | undefined>;
/**
* BLE AP settings
*/
readonly bleConfig: pulumi.Output<outputs.org.DeviceprofileApBleConfig | undefined>;
/**
* 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.org.DeviceprofileApEslConfig | undefined>;
/**
* IP AP settings
*/
readonly ipConfig: pulumi.Output<outputs.org.DeviceprofileApIpConfig | undefined>;
readonly lacpConfig: pulumi.Output<outputs.org.DeviceprofileApLacpConfig | undefined>;
/**
* LED AP settings
*/
readonly led: pulumi.Output<outputs.org.DeviceprofileApLed | undefined>;
/**
* Mesh AP settings
*/
readonly mesh: pulumi.Output<outputs.org.DeviceprofileApMesh | undefined>;
readonly name: pulumi.Output<string>;
readonly ntpServers: pulumi.Output<string[] | undefined>;
readonly orgId: pulumi.Output<string>;
/**
* 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.org.DeviceprofileApPortConfig;
} | undefined>;
/**
* Power related configs
*/
readonly pwrConfig: pulumi.Output<outputs.org.DeviceprofileApPwrConfig | undefined>;
/**
* Radio AP settings
*/
readonly radioConfig: pulumi.Output<outputs.org.DeviceprofileApRadioConfig | undefined>;
readonly siteId: pulumi.Output<string | undefined>;
/**
* Device Type. enum: `ap`
*/
readonly type: pulumi.Output<string>;
/**
* AP Uplink port configuration
*/
readonly uplinkPortConfig: pulumi.Output<outputs.org.DeviceprofileApUplinkPortConfig | 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.org.DeviceprofileApUsbConfig | 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>;
/**
* Create a DeviceprofileAp 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: DeviceprofileApArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DeviceprofileAp resources.
*/
export interface DeviceprofileApState {
/**
* Aeroscout AP settings
*/
aeroscout?: pulumi.Input<inputs.org.DeviceprofileApAeroscout>;
/**
* BLE AP settings
*/
bleConfig?: pulumi.Input<inputs.org.DeviceprofileApBleConfig>;
/**
* 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.org.DeviceprofileApEslConfig>;
/**
* IP AP settings
*/
ipConfig?: pulumi.Input<inputs.org.DeviceprofileApIpConfig>;
lacpConfig?: pulumi.Input<inputs.org.DeviceprofileApLacpConfig>;
/**
* LED AP settings
*/
led?: pulumi.Input<inputs.org.DeviceprofileApLed>;
/**
* Mesh AP settings
*/
mesh?: pulumi.Input<inputs.org.DeviceprofileApMesh>;
name?: pulumi.Input<string>;
ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
orgId?: pulumi.Input<string>;
/**
* 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.org.DeviceprofileApPortConfig>;
}>;
/**
* Power related configs
*/
pwrConfig?: pulumi.Input<inputs.org.DeviceprofileApPwrConfig>;
/**
* Radio AP settings
*/
radioConfig?: pulumi.Input<inputs.org.DeviceprofileApRadioConfig>;
siteId?: pulumi.Input<string>;
/**
* Device Type. enum: `ap`
*/
type?: pulumi.Input<string>;
/**
* AP Uplink port configuration
*/
uplinkPortConfig?: pulumi.Input<inputs.org.DeviceprofileApUplinkPortConfig>;
/**
* 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.org.DeviceprofileApUsbConfig>;
/**
* 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>;
}>;
}
/**
* The set of arguments for constructing a DeviceprofileAp resource.
*/
export interface DeviceprofileApArgs {
/**
* Aeroscout AP settings
*/
aeroscout?: pulumi.Input<inputs.org.DeviceprofileApAeroscout>;
/**
* BLE AP settings
*/
bleConfig?: pulumi.Input<inputs.org.DeviceprofileApBleConfig>;
/**
* 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.org.DeviceprofileApEslConfig>;
/**
* IP AP settings
*/
ipConfig?: pulumi.Input<inputs.org.DeviceprofileApIpConfig>;
lacpConfig?: pulumi.Input<inputs.org.DeviceprofileApLacpConfig>;
/**
* LED AP settings
*/
led?: pulumi.Input<inputs.org.DeviceprofileApLed>;
/**
* Mesh AP settings
*/
mesh?: pulumi.Input<inputs.org.DeviceprofileApMesh>;
name?: pulumi.Input<string>;
ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
orgId: pulumi.Input<string>;
/**
* 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.org.DeviceprofileApPortConfig>;
}>;
/**
* Power related configs
*/
pwrConfig?: pulumi.Input<inputs.org.DeviceprofileApPwrConfig>;
/**
* Radio AP settings
*/
radioConfig?: pulumi.Input<inputs.org.DeviceprofileApRadioConfig>;
siteId?: pulumi.Input<string>;
/**
* AP Uplink port configuration
*/
uplinkPortConfig?: pulumi.Input<inputs.org.DeviceprofileApUplinkPortConfig>;
/**
* 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.org.DeviceprofileApUsbConfig>;
/**
* 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>;
}>;
}