@pulumi/juniper-mist/site/setting.d.ts

A Pulumi package for creating and managing Juniper Mist resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * This resource manages the Site Settings.
 *
 * The Site Settings can be used to customize the Site configuration and assign Site Variables (Sites Variables can be reused in configuration templates)
 *
 * > When using the Mist APIs, all the switch settings defined at the site level are stored under the site settings with all the rest of the site configuration (`/api/v1/sites/{site_id}/setting` Mist API Endpoint). To simplify this resource, all the site level switches related settings are moved into the `junipermist.site.Networktemplate` resource
 *
 * !> Only ONE `junipermist.site.Setting` resource can be configured per site. If multiple ones are configured, only the last one defined we be successfully deployed to Mist
 *
 * ## Import
 *
 * Using `pulumi import`, import `mist_site_setting` with:
 *
 * Site Setting can be imported by specifying the site_id
 *
 * ```sh
 * $ pulumi import junipermist:site/setting:Setting site_setting_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a
 * ```
 */
export declare class Setting extends pulumi.CustomResource {
    /**
     * Get an existing Setting 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?: SettingState, opts?: pulumi.CustomResourceOptions): Setting;
    /**
     * Returns true if the given object is an instance of Setting.  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 Setting;
    readonly analytic: pulumi.Output<outputs.site.SettingAnalytic>;
    /**
     * Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and
     * `deviceUpdownThreshold` is ignored.
     */
    readonly apUpdownThreshold: pulumi.Output<number | undefined>;
    /**
     * Auto Upgrade Settings
     */
    readonly autoUpgrade: pulumi.Output<outputs.site.SettingAutoUpgrade>;
    readonly blacklistUrl: pulumi.Output<string>;
    /**
     * BLE AP settings
     */
    readonly bleConfig: pulumi.Output<outputs.site.SettingBleConfig | undefined>;
    /**
     * Whether to enable ap auto config revert
     */
    readonly configAutoRevert: pulumi.Output<boolean>;
    /**
     * Mist also uses some heuristic rules to prevent destructive configs from being pushed
     */
    readonly configPushPolicy: pulumi.Output<outputs.site.SettingConfigPushPolicy | undefined>;
    /**
     * You can define some URLs that's critical to site operations the latency will be captured and considered for site health
     */
    readonly criticalUrlMonitoring: pulumi.Output<outputs.site.SettingCriticalUrlMonitoring | undefined>;
    /**
     * By default, device_updown_threshold, if set, will apply to all devices types if different values for specific device
     * type is desired, use the following
     */
    readonly deviceUpdownThreshold: pulumi.Output<number | undefined>;
    readonly enableUnii4: pulumi.Output<boolean>;
    /**
     * **Note**: if hours does not exist, it's treated as everyday of the week, 00:00-23:59. Currently, we don't allow multiple
     * ranges for the same day
     */
    readonly engagement: pulumi.Output<outputs.site.SettingEngagement>;
    /**
     * Gateway Site settings
     */
    readonly gatewayMgmt: pulumi.Output<outputs.site.SettingGatewayMgmt>;
    /**
     * Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    readonly gatewayUpdownThreshold: pulumi.Output<number | undefined>;
    readonly juniperSrx: pulumi.Output<outputs.site.SettingJuniperSrx | undefined>;
    /**
     * LED AP settings
     */
    readonly led: pulumi.Output<outputs.site.SettingLed>;
    /**
     * Occupancy Analytics settings
     */
    readonly occupancy: pulumi.Output<outputs.site.SettingOccupancy>;
    /**
     * Whether to store the config on AP
     */
    readonly persistConfigOnDevice: pulumi.Output<boolean>;
    /**
     * Proxy Configuration to talk to Mist
     */
    readonly proxy: pulumi.Output<outputs.site.SettingProxy | undefined>;
    /**
     * By default, when we configure a device, we only clean up config we generate. Remove existing configs if enabled
     */
    readonly removeExistingConfigs: pulumi.Output<boolean | undefined>;
    /**
     * Whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name,
     * serial number, battery %, temperature, humidity)
     */
    readonly reportGatt: pulumi.Output<boolean | undefined>;
    /**
     * Rogue site settings
     */
    readonly rogue: pulumi.Output<outputs.site.SettingRogue>;
    /**
     * Managed mobility
     */
    readonly rtsa: pulumi.Output<outputs.site.SettingRtsa>;
    /**
     * Set of heuristic rules will be enabled when marvis subscription is not available. It triggers when, in a Z minute
     * window, there are more than Y distinct client encountering over X failures
     */
    readonly simpleAlert: pulumi.Output<outputs.site.SettingSimpleAlert | undefined>;
    readonly siteId: pulumi.Output<string>;
    readonly skyatp: pulumi.Output<outputs.site.SettingSkyatp | undefined>;
    readonly srxApp: pulumi.Output<outputs.site.SettingSrxApp | undefined>;
    /**
     * When limitSshAccess = true in Org Setting, list of SSH public keys provided by Mist Support to install onto APs (see
     * Org:Setting)
     */
    readonly sshKeys: pulumi.Output<string[]>;
    readonly ssr: pulumi.Output<outputs.site.SettingSsr>;
    /**
     * Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    readonly switchUpdownThreshold: pulumi.Output<number | undefined>;
    readonly syntheticTest: pulumi.Output<outputs.site.SettingSyntheticTest>;
    /**
     * Whether to track anonymous BLE assets (requires ‘track_asset’ enabled)
     */
    readonly trackAnonymousDevices: pulumi.Output<boolean | undefined>;
    /**
     * AP Uplink port configuration
     */
    readonly uplinkPortConfig: pulumi.Output<outputs.site.SettingUplinkPortConfig>;
    /**
     * 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>;
    readonly vna: pulumi.Output<outputs.site.SettingVna | undefined>;
    /**
     * Optional, for EX9200 only to segregate virtual-switches. Property key is the instance name
     */
    readonly vsInstance: pulumi.Output<{
        [key: string]: outputs.site.SettingVsInstance;
    } | undefined>;
    readonly wanVna: pulumi.Output<outputs.site.SettingWanVna | undefined>;
    readonly watchedStationUrl: pulumi.Output<string>;
    readonly whitelistUrl: pulumi.Output<string>;
    /**
     * WIDS site settings
     */
    readonly wids: pulumi.Output<outputs.site.SettingWids>;
    /**
     * Wi-Fi site settings
     */
    readonly wifi: pulumi.Output<outputs.site.SettingWifi>;
    readonly wiredVna: pulumi.Output<outputs.site.SettingWiredVna | undefined>;
    /**
     * Zone Occupancy alert site settings
     */
    readonly zoneOccupancyAlert: pulumi.Output<outputs.site.SettingZoneOccupancyAlert>;
    /**
     * Create a Setting 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: SettingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Setting resources.
 */
export interface SettingState {
    analytic?: pulumi.Input<inputs.site.SettingAnalytic>;
    /**
     * Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and
     * `deviceUpdownThreshold` is ignored.
     */
    apUpdownThreshold?: pulumi.Input<number>;
    /**
     * Auto Upgrade Settings
     */
    autoUpgrade?: pulumi.Input<inputs.site.SettingAutoUpgrade>;
    blacklistUrl?: pulumi.Input<string>;
    /**
     * BLE AP settings
     */
    bleConfig?: pulumi.Input<inputs.site.SettingBleConfig>;
    /**
     * Whether to enable ap auto config revert
     */
    configAutoRevert?: pulumi.Input<boolean>;
    /**
     * Mist also uses some heuristic rules to prevent destructive configs from being pushed
     */
    configPushPolicy?: pulumi.Input<inputs.site.SettingConfigPushPolicy>;
    /**
     * You can define some URLs that's critical to site operations the latency will be captured and considered for site health
     */
    criticalUrlMonitoring?: pulumi.Input<inputs.site.SettingCriticalUrlMonitoring>;
    /**
     * By default, device_updown_threshold, if set, will apply to all devices types if different values for specific device
     * type is desired, use the following
     */
    deviceUpdownThreshold?: pulumi.Input<number>;
    enableUnii4?: pulumi.Input<boolean>;
    /**
     * **Note**: if hours does not exist, it's treated as everyday of the week, 00:00-23:59. Currently, we don't allow multiple
     * ranges for the same day
     */
    engagement?: pulumi.Input<inputs.site.SettingEngagement>;
    /**
     * Gateway Site settings
     */
    gatewayMgmt?: pulumi.Input<inputs.site.SettingGatewayMgmt>;
    /**
     * Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    gatewayUpdownThreshold?: pulumi.Input<number>;
    juniperSrx?: pulumi.Input<inputs.site.SettingJuniperSrx>;
    /**
     * LED AP settings
     */
    led?: pulumi.Input<inputs.site.SettingLed>;
    /**
     * Occupancy Analytics settings
     */
    occupancy?: pulumi.Input<inputs.site.SettingOccupancy>;
    /**
     * Whether to store the config on AP
     */
    persistConfigOnDevice?: pulumi.Input<boolean>;
    /**
     * Proxy Configuration to talk to Mist
     */
    proxy?: pulumi.Input<inputs.site.SettingProxy>;
    /**
     * By default, when we configure a device, we only clean up config we generate. Remove existing configs if enabled
     */
    removeExistingConfigs?: pulumi.Input<boolean>;
    /**
     * Whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name,
     * serial number, battery %, temperature, humidity)
     */
    reportGatt?: pulumi.Input<boolean>;
    /**
     * Rogue site settings
     */
    rogue?: pulumi.Input<inputs.site.SettingRogue>;
    /**
     * Managed mobility
     */
    rtsa?: pulumi.Input<inputs.site.SettingRtsa>;
    /**
     * Set of heuristic rules will be enabled when marvis subscription is not available. It triggers when, in a Z minute
     * window, there are more than Y distinct client encountering over X failures
     */
    simpleAlert?: pulumi.Input<inputs.site.SettingSimpleAlert>;
    siteId?: pulumi.Input<string>;
    skyatp?: pulumi.Input<inputs.site.SettingSkyatp>;
    srxApp?: pulumi.Input<inputs.site.SettingSrxApp>;
    /**
     * When limitSshAccess = true in Org Setting, list of SSH public keys provided by Mist Support to install onto APs (see
     * Org:Setting)
     */
    sshKeys?: pulumi.Input<pulumi.Input<string>[]>;
    ssr?: pulumi.Input<inputs.site.SettingSsr>;
    /**
     * Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    switchUpdownThreshold?: pulumi.Input<number>;
    syntheticTest?: pulumi.Input<inputs.site.SettingSyntheticTest>;
    /**
     * Whether to track anonymous BLE assets (requires ‘track_asset’ enabled)
     */
    trackAnonymousDevices?: pulumi.Input<boolean>;
    /**
     * AP Uplink port configuration
     */
    uplinkPortConfig?: pulumi.Input<inputs.site.SettingUplinkPortConfig>;
    /**
     * 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>;
    }>;
    vna?: pulumi.Input<inputs.site.SettingVna>;
    /**
     * Optional, for EX9200 only to segregate virtual-switches. Property key is the instance name
     */
    vsInstance?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.site.SettingVsInstance>;
    }>;
    wanVna?: pulumi.Input<inputs.site.SettingWanVna>;
    watchedStationUrl?: pulumi.Input<string>;
    whitelistUrl?: pulumi.Input<string>;
    /**
     * WIDS site settings
     */
    wids?: pulumi.Input<inputs.site.SettingWids>;
    /**
     * Wi-Fi site settings
     */
    wifi?: pulumi.Input<inputs.site.SettingWifi>;
    wiredVna?: pulumi.Input<inputs.site.SettingWiredVna>;
    /**
     * Zone Occupancy alert site settings
     */
    zoneOccupancyAlert?: pulumi.Input<inputs.site.SettingZoneOccupancyAlert>;
}
/**
 * The set of arguments for constructing a Setting resource.
 */
export interface SettingArgs {
    analytic?: pulumi.Input<inputs.site.SettingAnalytic>;
    /**
     * Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and
     * `deviceUpdownThreshold` is ignored.
     */
    apUpdownThreshold?: pulumi.Input<number>;
    /**
     * Auto Upgrade Settings
     */
    autoUpgrade?: pulumi.Input<inputs.site.SettingAutoUpgrade>;
    /**
     * BLE AP settings
     */
    bleConfig?: pulumi.Input<inputs.site.SettingBleConfig>;
    /**
     * Whether to enable ap auto config revert
     */
    configAutoRevert?: pulumi.Input<boolean>;
    /**
     * Mist also uses some heuristic rules to prevent destructive configs from being pushed
     */
    configPushPolicy?: pulumi.Input<inputs.site.SettingConfigPushPolicy>;
    /**
     * You can define some URLs that's critical to site operations the latency will be captured and considered for site health
     */
    criticalUrlMonitoring?: pulumi.Input<inputs.site.SettingCriticalUrlMonitoring>;
    /**
     * By default, device_updown_threshold, if set, will apply to all devices types if different values for specific device
     * type is desired, use the following
     */
    deviceUpdownThreshold?: pulumi.Input<number>;
    enableUnii4?: pulumi.Input<boolean>;
    /**
     * **Note**: if hours does not exist, it's treated as everyday of the week, 00:00-23:59. Currently, we don't allow multiple
     * ranges for the same day
     */
    engagement?: pulumi.Input<inputs.site.SettingEngagement>;
    /**
     * Gateway Site settings
     */
    gatewayMgmt?: pulumi.Input<inputs.site.SettingGatewayMgmt>;
    /**
     * Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    gatewayUpdownThreshold?: pulumi.Input<number>;
    juniperSrx?: pulumi.Input<inputs.site.SettingJuniperSrx>;
    /**
     * LED AP settings
     */
    led?: pulumi.Input<inputs.site.SettingLed>;
    /**
     * Occupancy Analytics settings
     */
    occupancy?: pulumi.Input<inputs.site.SettingOccupancy>;
    /**
     * Whether to store the config on AP
     */
    persistConfigOnDevice?: pulumi.Input<boolean>;
    /**
     * Proxy Configuration to talk to Mist
     */
    proxy?: pulumi.Input<inputs.site.SettingProxy>;
    /**
     * By default, when we configure a device, we only clean up config we generate. Remove existing configs if enabled
     */
    removeExistingConfigs?: pulumi.Input<boolean>;
    /**
     * Whether AP should periodically connect to BLE devices and report GATT device info (device name, manufacturer name,
     * serial number, battery %, temperature, humidity)
     */
    reportGatt?: pulumi.Input<boolean>;
    /**
     * Rogue site settings
     */
    rogue?: pulumi.Input<inputs.site.SettingRogue>;
    /**
     * Managed mobility
     */
    rtsa?: pulumi.Input<inputs.site.SettingRtsa>;
    /**
     * Set of heuristic rules will be enabled when marvis subscription is not available. It triggers when, in a Z minute
     * window, there are more than Y distinct client encountering over X failures
     */
    simpleAlert?: pulumi.Input<inputs.site.SettingSimpleAlert>;
    siteId: pulumi.Input<string>;
    skyatp?: pulumi.Input<inputs.site.SettingSkyatp>;
    srxApp?: pulumi.Input<inputs.site.SettingSrxApp>;
    /**
     * When limitSshAccess = true in Org Setting, list of SSH public keys provided by Mist Support to install onto APs (see
     * Org:Setting)
     */
    sshKeys?: pulumi.Input<pulumi.Input<string>[]>;
    ssr?: pulumi.Input<inputs.site.SettingSsr>;
    /**
     * Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and
     * `deviceUpdownThreshold` is ignored.
     */
    switchUpdownThreshold?: pulumi.Input<number>;
    syntheticTest?: pulumi.Input<inputs.site.SettingSyntheticTest>;
    /**
     * Whether to track anonymous BLE assets (requires ‘track_asset’ enabled)
     */
    trackAnonymousDevices?: pulumi.Input<boolean>;
    /**
     * AP Uplink port configuration
     */
    uplinkPortConfig?: pulumi.Input<inputs.site.SettingUplinkPortConfig>;
    /**
     * 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>;
    }>;
    vna?: pulumi.Input<inputs.site.SettingVna>;
    /**
     * Optional, for EX9200 only to segregate virtual-switches. Property key is the instance name
     */
    vsInstance?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.site.SettingVsInstance>;
    }>;
    wanVna?: pulumi.Input<inputs.site.SettingWanVna>;
    /**
     * WIDS site settings
     */
    wids?: pulumi.Input<inputs.site.SettingWids>;
    /**
     * Wi-Fi site settings
     */
    wifi?: pulumi.Input<inputs.site.SettingWifi>;
    wiredVna?: pulumi.Input<inputs.site.SettingWiredVna>;
    /**
     * Zone Occupancy alert site settings
     */
    zoneOccupancyAlert?: pulumi.Input<inputs.site.SettingZoneOccupancyAlert>;
}