@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
588 lines • 22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource manages the Org Settings.
*
* The Org Settings can be used to customize the Org configuration
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const terraformTest = new junipermist.org.Setting("terraform_test", {
* orgId: terraformTestMistOrg.id,
* apUpdownThreshold: 10,
* cradlepoint: {
* cpApiId: "cp_api_id_test",
* cpApiKey: "secret",
* ecmApiId: "ecm_api_id_test",
* ecmApiKey: "secret",
* },
* deviceUpdownThreshold: 10,
* disablePcap: false,
* disableRemoteShell: true,
* gatewayUpdownThreshold: 10,
* mxedgeMgmt: {
* mistPassword: "root_secret_password",
* rootPassword: "root_secret_password",
* oobIpType: "dhcp",
* oobIpType6: "disabled",
* },
* passwordPolicy: {
* enabled: true,
* freshness: 180,
* minLength: 12,
* requiresSpecialChar: true,
* requiresTwoFactorAuth: false,
* },
* security: {
* disableLocalSsh: true,
* },
* switchUpdownThreshold: 10,
* syntheticTest: {
* disabled: false,
* vlans: [
* {
* vlanIds: [
* "10",
* "30",
* ],
* customTestUrls: [
* "http://www.abc.com/",
* "https://10.3.5.1:8080/about",
* ],
* },
* {
* vlanIds: ["20"],
* disabled: true,
* },
* ],
* },
* uiIdleTimeout: 120,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `junipermist.org.Setting` with:
* Org Setting can be imported by specifying the orgId
*
* ```sh
* $ pulumi import junipermist:org/setting:Setting 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;
/**
* whether to allow Mist to look at this org
*/
readonly allowMist: pulumi.Output<boolean>;
/**
* 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>;
/**
* Policy for hiding API secrets and passwords in responses
*/
readonly apiPolicy: pulumi.Output<outputs.org.SettingApiPolicy | undefined>;
/**
* AP automatic firmware upgrade policy for the organization
*/
readonly autoUpgrade: pulumi.Output<outputs.org.SettingAutoUpgrade | undefined>;
/**
* CA certificates used by organization-level RADIUS and RADSec settings
*/
readonly cacerts: pulumi.Output<string[]>;
/**
* Integration settings for Celona
*/
readonly celona: pulumi.Output<outputs.org.SettingCelona | undefined>;
/**
* Packet capture integration settings for CloudShark
*/
readonly cloudshark: pulumi.Output<outputs.org.SettingCloudshark | undefined>;
/**
* Integration settings for Cradlepoint devices
*/
readonly cradlepoint: pulumi.Output<outputs.org.SettingCradlepoint>;
/**
* Common device certificate used by organization settings
*/
readonly deviceCert: pulumi.Output<outputs.org.SettingDeviceCert | undefined>;
/**
* Enable threshold-based device down delivery via
* * device-updowns webhooks topic,
* * Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)
*/
readonly deviceUpdownThreshold: pulumi.Output<number | undefined>;
/**
* Whether to disallow Mist to analyze pcap files (this is required for marvis pcap)
*/
readonly disablePcap: pulumi.Output<boolean | undefined>;
/**
* Whether to disable remote shell access for an entire org
*/
readonly disableRemoteShell: pulumi.Output<boolean | undefined>;
/**
* enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
*/
readonly gatewayTunnelUpdownThreshold: pulumi.Output<number | undefined>;
/**
* 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>;
/**
* Access settings for organization installer workflows
*/
readonly installer: pulumi.Output<outputs.org.SettingInstaller | undefined>;
/**
* Integration settings for JCloud
*/
readonly jcloud: pulumi.Output<outputs.org.SettingJcloud | undefined>;
/**
* Routing Assurance integration settings for JCloud
*/
readonly jcloudRa: pulumi.Output<outputs.org.SettingJcloudRa | undefined>;
/**
* Linked Juniper account information for this organization
*/
readonly juniper: pulumi.Output<outputs.org.SettingJuniper>;
/**
* SRX integration settings for Juniper devices
*/
readonly juniperSrx: pulumi.Output<outputs.org.SettingJuniperSrx | undefined>;
/**
* Role-based Junos web-shell access settings
*/
readonly junosShellAccess: pulumi.Output<outputs.org.SettingJunosShellAccess | undefined>;
/**
* AI assistant and self-driving feature settings for Marvis
*/
readonly marvis: pulumi.Output<outputs.org.SettingMarvis | undefined>;
/**
* Tunnel settings for organization management connectivity
*/
readonly mgmt: pulumi.Output<outputs.org.SettingMgmt | undefined>;
/**
* NAC settings for Mist Access Assurance
*/
readonly mistNac: pulumi.Output<outputs.org.SettingMistNac | undefined>;
/**
* Management settings for Mist Edge devices
*/
readonly mxedgeMgmt: pulumi.Output<outputs.org.SettingMxedgeMgmt | undefined>;
/**
* Configuration defaults for optic ports
*/
readonly opticPortConfig: pulumi.Output<{
[key: string]: outputs.org.SettingOpticPortConfig;
} | undefined>;
/**
* Organization that owns these settings
*/
readonly orgId: pulumi.Output<string>;
/**
* Admin credential policy settings for the organization
*/
readonly passwordPolicy: pulumi.Output<outputs.org.SettingPasswordPolicy | undefined>;
/**
* Packet capture settings for the organization
*/
readonly pcap: pulumi.Output<outputs.org.SettingPcap>;
/**
* Organization security controls such as local SSH restrictions
*/
readonly security: pulumi.Output<outputs.org.SettingSecurity | undefined>;
/**
* Session Smart Router settings for the organization
*/
readonly ssr: pulumi.Output<outputs.org.SettingSsr | undefined>;
/**
* Configuration defaults for switches in this organization
*/
readonly switch: pulumi.Output<outputs.org.SettingSwitch | undefined>;
/**
* Management settings for switches in this organization
*/
readonly switchMgmt: pulumi.Output<outputs.org.SettingSwitchMgmt | undefined>;
/**
* 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>;
/**
* Configuration for organization synthetic tests
*/
readonly syntheticTest: pulumi.Output<outputs.org.SettingSyntheticTest | undefined>;
/**
* Automatically logout the user when UI session is inactive. `0` means disabled
*/
readonly uiIdleTimeout: pulumi.Output<number>;
/**
* Whether UI usage tracking is disabled for the organization
*/
readonly uiNoTracking: pulumi.Output<boolean | undefined>;
/**
* Options for organization VPN behavior
*/
readonly vpnOptions: pulumi.Output<outputs.org.SettingVpnOptions | undefined>;
/**
* PMA feature settings for WAN Assurance
*/
readonly wanPma: pulumi.Output<outputs.org.SettingWanPma | undefined>;
/**
* PMA feature settings for Wired Assurance
*/
readonly wiredPma: pulumi.Output<outputs.org.SettingWiredPma | undefined>;
/**
* PMA feature settings for Wireless Assurance
*/
readonly wirelessPma: pulumi.Output<outputs.org.SettingWirelessPma | undefined>;
/**
* 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 {
/**
* whether to allow Mist to look at this org
*/
allowMist?: pulumi.Input<boolean | undefined>;
/**
* 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 | undefined>;
/**
* Policy for hiding API secrets and passwords in responses
*/
apiPolicy?: pulumi.Input<inputs.org.SettingApiPolicy | undefined>;
/**
* AP automatic firmware upgrade policy for the organization
*/
autoUpgrade?: pulumi.Input<inputs.org.SettingAutoUpgrade | undefined>;
/**
* CA certificates used by organization-level RADIUS and RADSec settings
*/
cacerts?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Integration settings for Celona
*/
celona?: pulumi.Input<inputs.org.SettingCelona | undefined>;
/**
* Packet capture integration settings for CloudShark
*/
cloudshark?: pulumi.Input<inputs.org.SettingCloudshark | undefined>;
/**
* Integration settings for Cradlepoint devices
*/
cradlepoint?: pulumi.Input<inputs.org.SettingCradlepoint | undefined>;
/**
* Common device certificate used by organization settings
*/
deviceCert?: pulumi.Input<inputs.org.SettingDeviceCert | undefined>;
/**
* Enable threshold-based device down delivery via
* * device-updowns webhooks topic,
* * Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)
*/
deviceUpdownThreshold?: pulumi.Input<number | undefined>;
/**
* Whether to disallow Mist to analyze pcap files (this is required for marvis pcap)
*/
disablePcap?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable remote shell access for an entire org
*/
disableRemoteShell?: pulumi.Input<boolean | undefined>;
/**
* enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
*/
gatewayTunnelUpdownThreshold?: pulumi.Input<number | undefined>;
/**
* 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 | undefined>;
/**
* Access settings for organization installer workflows
*/
installer?: pulumi.Input<inputs.org.SettingInstaller | undefined>;
/**
* Integration settings for JCloud
*/
jcloud?: pulumi.Input<inputs.org.SettingJcloud | undefined>;
/**
* Routing Assurance integration settings for JCloud
*/
jcloudRa?: pulumi.Input<inputs.org.SettingJcloudRa | undefined>;
/**
* Linked Juniper account information for this organization
*/
juniper?: pulumi.Input<inputs.org.SettingJuniper | undefined>;
/**
* SRX integration settings for Juniper devices
*/
juniperSrx?: pulumi.Input<inputs.org.SettingJuniperSrx | undefined>;
/**
* Role-based Junos web-shell access settings
*/
junosShellAccess?: pulumi.Input<inputs.org.SettingJunosShellAccess | undefined>;
/**
* AI assistant and self-driving feature settings for Marvis
*/
marvis?: pulumi.Input<inputs.org.SettingMarvis | undefined>;
/**
* Tunnel settings for organization management connectivity
*/
mgmt?: pulumi.Input<inputs.org.SettingMgmt | undefined>;
/**
* NAC settings for Mist Access Assurance
*/
mistNac?: pulumi.Input<inputs.org.SettingMistNac | undefined>;
/**
* Management settings for Mist Edge devices
*/
mxedgeMgmt?: pulumi.Input<inputs.org.SettingMxedgeMgmt | undefined>;
/**
* Configuration defaults for optic ports
*/
opticPortConfig?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.org.SettingOpticPortConfig>;
} | undefined>;
/**
* Organization that owns these settings
*/
orgId?: pulumi.Input<string | undefined>;
/**
* Admin credential policy settings for the organization
*/
passwordPolicy?: pulumi.Input<inputs.org.SettingPasswordPolicy | undefined>;
/**
* Packet capture settings for the organization
*/
pcap?: pulumi.Input<inputs.org.SettingPcap | undefined>;
/**
* Organization security controls such as local SSH restrictions
*/
security?: pulumi.Input<inputs.org.SettingSecurity | undefined>;
/**
* Session Smart Router settings for the organization
*/
ssr?: pulumi.Input<inputs.org.SettingSsr | undefined>;
/**
* Configuration defaults for switches in this organization
*/
switch?: pulumi.Input<inputs.org.SettingSwitch | undefined>;
/**
* Management settings for switches in this organization
*/
switchMgmt?: pulumi.Input<inputs.org.SettingSwitchMgmt | undefined>;
/**
* 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 | undefined>;
/**
* Configuration for organization synthetic tests
*/
syntheticTest?: pulumi.Input<inputs.org.SettingSyntheticTest | undefined>;
/**
* Automatically logout the user when UI session is inactive. `0` means disabled
*/
uiIdleTimeout?: pulumi.Input<number | undefined>;
/**
* Whether UI usage tracking is disabled for the organization
*/
uiNoTracking?: pulumi.Input<boolean | undefined>;
/**
* Options for organization VPN behavior
*/
vpnOptions?: pulumi.Input<inputs.org.SettingVpnOptions | undefined>;
/**
* PMA feature settings for WAN Assurance
*/
wanPma?: pulumi.Input<inputs.org.SettingWanPma | undefined>;
/**
* PMA feature settings for Wired Assurance
*/
wiredPma?: pulumi.Input<inputs.org.SettingWiredPma | undefined>;
/**
* PMA feature settings for Wireless Assurance
*/
wirelessPma?: pulumi.Input<inputs.org.SettingWirelessPma | undefined>;
}
/**
* The set of arguments for constructing a Setting resource.
*/
export interface SettingArgs {
/**
* 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 | undefined>;
/**
* Policy for hiding API secrets and passwords in responses
*/
apiPolicy?: pulumi.Input<inputs.org.SettingApiPolicy | undefined>;
/**
* AP automatic firmware upgrade policy for the organization
*/
autoUpgrade?: pulumi.Input<inputs.org.SettingAutoUpgrade | undefined>;
/**
* CA certificates used by organization-level RADIUS and RADSec settings
*/
cacerts?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Integration settings for Celona
*/
celona?: pulumi.Input<inputs.org.SettingCelona | undefined>;
/**
* Packet capture integration settings for CloudShark
*/
cloudshark?: pulumi.Input<inputs.org.SettingCloudshark | undefined>;
/**
* Common device certificate used by organization settings
*/
deviceCert?: pulumi.Input<inputs.org.SettingDeviceCert | undefined>;
/**
* Enable threshold-based device down delivery via
* * device-updowns webhooks topic,
* * Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)
*/
deviceUpdownThreshold?: pulumi.Input<number | undefined>;
/**
* Whether to disallow Mist to analyze pcap files (this is required for marvis pcap)
*/
disablePcap?: pulumi.Input<boolean | undefined>;
/**
* Whether to disable remote shell access for an entire org
*/
disableRemoteShell?: pulumi.Input<boolean | undefined>;
/**
* enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.
*/
gatewayTunnelUpdownThreshold?: pulumi.Input<number | undefined>;
/**
* 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 | undefined>;
/**
* Access settings for organization installer workflows
*/
installer?: pulumi.Input<inputs.org.SettingInstaller | undefined>;
/**
* Integration settings for JCloud
*/
jcloud?: pulumi.Input<inputs.org.SettingJcloud | undefined>;
/**
* Routing Assurance integration settings for JCloud
*/
jcloudRa?: pulumi.Input<inputs.org.SettingJcloudRa | undefined>;
/**
* SRX integration settings for Juniper devices
*/
juniperSrx?: pulumi.Input<inputs.org.SettingJuniperSrx | undefined>;
/**
* Role-based Junos web-shell access settings
*/
junosShellAccess?: pulumi.Input<inputs.org.SettingJunosShellAccess | undefined>;
/**
* AI assistant and self-driving feature settings for Marvis
*/
marvis?: pulumi.Input<inputs.org.SettingMarvis | undefined>;
/**
* Tunnel settings for organization management connectivity
*/
mgmt?: pulumi.Input<inputs.org.SettingMgmt | undefined>;
/**
* NAC settings for Mist Access Assurance
*/
mistNac?: pulumi.Input<inputs.org.SettingMistNac | undefined>;
/**
* Management settings for Mist Edge devices
*/
mxedgeMgmt?: pulumi.Input<inputs.org.SettingMxedgeMgmt | undefined>;
/**
* Configuration defaults for optic ports
*/
opticPortConfig?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.org.SettingOpticPortConfig>;
} | undefined>;
/**
* Organization that owns these settings
*/
orgId: pulumi.Input<string>;
/**
* Admin credential policy settings for the organization
*/
passwordPolicy?: pulumi.Input<inputs.org.SettingPasswordPolicy | undefined>;
/**
* Organization security controls such as local SSH restrictions
*/
security?: pulumi.Input<inputs.org.SettingSecurity | undefined>;
/**
* Session Smart Router settings for the organization
*/
ssr?: pulumi.Input<inputs.org.SettingSsr | undefined>;
/**
* Configuration defaults for switches in this organization
*/
switch?: pulumi.Input<inputs.org.SettingSwitch | undefined>;
/**
* Management settings for switches in this organization
*/
switchMgmt?: pulumi.Input<inputs.org.SettingSwitchMgmt | undefined>;
/**
* 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 | undefined>;
/**
* Configuration for organization synthetic tests
*/
syntheticTest?: pulumi.Input<inputs.org.SettingSyntheticTest | undefined>;
/**
* Automatically logout the user when UI session is inactive. `0` means disabled
*/
uiIdleTimeout?: pulumi.Input<number | undefined>;
/**
* Whether UI usage tracking is disabled for the organization
*/
uiNoTracking?: pulumi.Input<boolean | undefined>;
/**
* Options for organization VPN behavior
*/
vpnOptions?: pulumi.Input<inputs.org.SettingVpnOptions | undefined>;
/**
* PMA feature settings for WAN Assurance
*/
wanPma?: pulumi.Input<inputs.org.SettingWanPma | undefined>;
/**
* PMA feature settings for Wired Assurance
*/
wiredPma?: pulumi.Input<inputs.org.SettingWiredPma | undefined>;
/**
* PMA feature settings for Wireless Assurance
*/
wirelessPma?: pulumi.Input<inputs.org.SettingWirelessPma | undefined>;
}
//# sourceMappingURL=setting.d.ts.map