@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
391 lines • 14.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 `junipermist.org.DeviceprofileAp` with:
* Device Profile can be imported by specifying the orgId and the deviceprofileId
*
* ```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;
/**
* Location integration defaults for AeroScout in this AP profile
*/
readonly aeroscout: pulumi.Output<outputs.org.DeviceprofileApAeroscout | undefined>;
/**
* Location integration defaults for Airista in this AP profile
*/
readonly airista: pulumi.Output<outputs.org.DeviceprofileApAirista | undefined>;
/**
* Bluetooth Low Energy beacon and asset defaults in this AP profile
*/
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>;
/**
* Electronic shelf label integration defaults in this AP profile
*/
readonly eslConfig: pulumi.Output<outputs.org.DeviceprofileApEslConfig | undefined>;
/**
* Management IP addressing defaults in this AP profile
*/
readonly ipConfig: pulumi.Output<outputs.org.DeviceprofileApIpConfig | undefined>;
/**
* Link aggregation defaults for supported AP Ethernet uplinks
*/
readonly lacpConfig: pulumi.Output<outputs.org.DeviceprofileApLacpConfig | undefined>;
/**
* Indicator light behavior defaults in this AP profile
*/
readonly led: pulumi.Output<outputs.org.DeviceprofileApLed | undefined>;
/**
* Wireless mesh role and band defaults in this AP profile
*/
readonly mesh: pulumi.Output<outputs.org.DeviceprofileApMesh | undefined>;
/**
* MQTT broker publishing settings for this AP profile
*/
readonly mqttConfig: pulumi.Output<outputs.org.DeviceprofileApMqttConfig | undefined>;
/**
* Display name of the AP device profile
*/
readonly name: pulumi.Output<string>;
/**
* NTP servers configured by this AP profile
*/
readonly ntpServers: pulumi.Output<string[] | undefined>;
/**
* Organization that owns this AP device profile
*/
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 negotiation and peripheral power defaults in this AP profile
*/
readonly pwrConfig: pulumi.Output<outputs.org.DeviceprofileApPwrConfig | undefined>;
/**
* Radio configuration defaults in this AP profile
*/
readonly radioConfig: pulumi.Output<outputs.org.DeviceprofileApRadioConfig | undefined>;
/**
* Site where this AP device profile is defined, when scoped to a site
*/
readonly siteId: pulumi.Output<string | undefined>;
/**
* Device type discriminator for AP device profiles
*/
readonly type: pulumi.Output<string>;
/**
* Authentication and failover defaults for AP uplink ports
*/
readonly uplinkPortConfig: pulumi.Output<outputs.org.DeviceprofileApUplinkPortConfig | undefined>;
/**
* Legacy USB integration defaults in this AP profile
*/
readonly usbConfig: pulumi.Output<outputs.org.DeviceprofileApUsbConfig | undefined>;
/**
* Variable values provided by this AP device profile
*/
readonly vars: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Zigbee radio and network defaults in this AP profile
*/
readonly zigbeeConfig: pulumi.Output<outputs.org.DeviceprofileApZigbeeConfig | 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 {
/**
* Location integration defaults for AeroScout in this AP profile
*/
aeroscout?: pulumi.Input<inputs.org.DeviceprofileApAeroscout | undefined>;
/**
* Location integration defaults for Airista in this AP profile
*/
airista?: pulumi.Input<inputs.org.DeviceprofileApAirista | undefined>;
/**
* Bluetooth Low Energy beacon and asset defaults in this AP profile
*/
bleConfig?: pulumi.Input<inputs.org.DeviceprofileApBleConfig | undefined>;
/**
* Whether to disable eth1 port
*/
disableEth1?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable eth2 port
*/
disableEth2?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable eth3 port
*/
disableEth3?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable module port
*/
disableModule?: pulumi.Input<boolean | undefined>;
/**
* Electronic shelf label integration defaults in this AP profile
*/
eslConfig?: pulumi.Input<inputs.org.DeviceprofileApEslConfig | undefined>;
/**
* Management IP addressing defaults in this AP profile
*/
ipConfig?: pulumi.Input<inputs.org.DeviceprofileApIpConfig | undefined>;
/**
* Link aggregation defaults for supported AP Ethernet uplinks
*/
lacpConfig?: pulumi.Input<inputs.org.DeviceprofileApLacpConfig | undefined>;
/**
* Indicator light behavior defaults in this AP profile
*/
led?: pulumi.Input<inputs.org.DeviceprofileApLed | undefined>;
/**
* Wireless mesh role and band defaults in this AP profile
*/
mesh?: pulumi.Input<inputs.org.DeviceprofileApMesh | undefined>;
/**
* MQTT broker publishing settings for this AP profile
*/
mqttConfig?: pulumi.Input<inputs.org.DeviceprofileApMqttConfig | undefined>;
/**
* Display name of the AP device profile
*/
name?: pulumi.Input<string | undefined>;
/**
* NTP servers configured by this AP profile
*/
ntpServers?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Organization that owns this AP device profile
*/
orgId?: pulumi.Input<string | undefined>;
/**
* Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
*/
poePassthrough?: pulumi.Input<boolean | undefined>;
/**
* 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>;
} | undefined>;
/**
* Power negotiation and peripheral power defaults in this AP profile
*/
pwrConfig?: pulumi.Input<inputs.org.DeviceprofileApPwrConfig | undefined>;
/**
* Radio configuration defaults in this AP profile
*/
radioConfig?: pulumi.Input<inputs.org.DeviceprofileApRadioConfig | undefined>;
/**
* Site where this AP device profile is defined, when scoped to a site
*/
siteId?: pulumi.Input<string | undefined>;
/**
* Device type discriminator for AP device profiles
*/
type?: pulumi.Input<string | undefined>;
/**
* Authentication and failover defaults for AP uplink ports
*/
uplinkPortConfig?: pulumi.Input<inputs.org.DeviceprofileApUplinkPortConfig | undefined>;
/**
* Legacy USB integration defaults in this AP profile
*/
usbConfig?: pulumi.Input<inputs.org.DeviceprofileApUsbConfig | undefined>;
/**
* Variable values provided by this AP device profile
*/
vars?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Zigbee radio and network defaults in this AP profile
*/
zigbeeConfig?: pulumi.Input<inputs.org.DeviceprofileApZigbeeConfig | undefined>;
}
/**
* The set of arguments for constructing a DeviceprofileAp resource.
*/
export interface DeviceprofileApArgs {
/**
* Location integration defaults for AeroScout in this AP profile
*/
aeroscout?: pulumi.Input<inputs.org.DeviceprofileApAeroscout | undefined>;
/**
* Location integration defaults for Airista in this AP profile
*/
airista?: pulumi.Input<inputs.org.DeviceprofileApAirista | undefined>;
/**
* Bluetooth Low Energy beacon and asset defaults in this AP profile
*/
bleConfig?: pulumi.Input<inputs.org.DeviceprofileApBleConfig | undefined>;
/**
* Whether to disable eth1 port
*/
disableEth1?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable eth2 port
*/
disableEth2?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable eth3 port
*/
disableEth3?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable module port
*/
disableModule?: pulumi.Input<boolean | undefined>;
/**
* Electronic shelf label integration defaults in this AP profile
*/
eslConfig?: pulumi.Input<inputs.org.DeviceprofileApEslConfig | undefined>;
/**
* Management IP addressing defaults in this AP profile
*/
ipConfig?: pulumi.Input<inputs.org.DeviceprofileApIpConfig | undefined>;
/**
* Link aggregation defaults for supported AP Ethernet uplinks
*/
lacpConfig?: pulumi.Input<inputs.org.DeviceprofileApLacpConfig | undefined>;
/**
* Indicator light behavior defaults in this AP profile
*/
led?: pulumi.Input<inputs.org.DeviceprofileApLed | undefined>;
/**
* Wireless mesh role and band defaults in this AP profile
*/
mesh?: pulumi.Input<inputs.org.DeviceprofileApMesh | undefined>;
/**
* MQTT broker publishing settings for this AP profile
*/
mqttConfig?: pulumi.Input<inputs.org.DeviceprofileApMqttConfig | undefined>;
/**
* Display name of the AP device profile
*/
name?: pulumi.Input<string | undefined>;
/**
* NTP servers configured by this AP profile
*/
ntpServers?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Organization that owns this AP device profile
*/
orgId: pulumi.Input<string>;
/**
* Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
*/
poePassthrough?: pulumi.Input<boolean | undefined>;
/**
* 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>;
} | undefined>;
/**
* Power negotiation and peripheral power defaults in this AP profile
*/
pwrConfig?: pulumi.Input<inputs.org.DeviceprofileApPwrConfig | undefined>;
/**
* Radio configuration defaults in this AP profile
*/
radioConfig?: pulumi.Input<inputs.org.DeviceprofileApRadioConfig | undefined>;
/**
* Site where this AP device profile is defined, when scoped to a site
*/
siteId?: pulumi.Input<string | undefined>;
/**
* Authentication and failover defaults for AP uplink ports
*/
uplinkPortConfig?: pulumi.Input<inputs.org.DeviceprofileApUplinkPortConfig | undefined>;
/**
* Legacy USB integration defaults in this AP profile
*/
usbConfig?: pulumi.Input<inputs.org.DeviceprofileApUsbConfig | undefined>;
/**
* Variable values provided by this AP device profile
*/
vars?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Zigbee radio and network defaults in this AP profile
*/
zigbeeConfig?: pulumi.Input<inputs.org.DeviceprofileApZigbeeConfig | undefined>;
}
//# sourceMappingURL=deviceprofileAp.d.ts.map