@pulumi/juniper-mist/org/deviceprofileGateway.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 Gateway Device Profiles (HUB Profiles).
 *
 * A HUB profile is a configuration profile that automates the creation of overlay networks and defines the attributes of a hub device in a network. It includes settings for wan interfaces, lan interfaces, dns servers, traffic steering preferences, application policies, and routing options. HUB profiles are used to create consistent configurations for hub devices and ensure efficient connectivity between hubs and spokes in a network.
 *
 * The Gateway Device Profile can be assigned to a gateway with the `junipermist.org.DeviceprofileAssign` resource.
 *
 * ## Import
 *
 * Using `pulumi import`, import `mist_org_deviceprofile_gateway` with:
 *
 * Device Profile can be imported by specifying the org_id and the deviceprofile_id
 *
 * ```sh
 * $ pulumi import junipermist:org/deviceprofileGateway:DeviceprofileGateway deviceprofile_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
 * ```
 */
export declare class DeviceprofileGateway extends pulumi.CustomResource {
    /**
     * Get an existing DeviceprofileGateway 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?: DeviceprofileGatewayState, opts?: pulumi.CustomResourceOptions): DeviceprofileGateway;
    /**
     * Returns true if the given object is an instance of DeviceprofileGateway.  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 DeviceprofileGateway;
    /**
     * additional CLI commands to append to the generated Junos config. **Note**: no check is done
     */
    readonly additionalConfigCmds: pulumi.Output<string[] | undefined>;
    readonly bgpConfig: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayBgpConfig;
    } | undefined>;
    readonly dhcpdConfig: pulumi.Output<outputs.org.DeviceprofileGatewayDhcpdConfig | undefined>;
    readonly dnsOverride: pulumi.Output<boolean | undefined>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    readonly dnsServers: pulumi.Output<string[] | undefined>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    readonly dnsSuffixes: pulumi.Output<string[] | undefined>;
    /**
     * Property key is the destination CIDR (e.g. "10.0.0.0/8"), the destination Network name or a variable (e.g. "{{myvar}}")
     */
    readonly extraRoutes: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayExtraRoutes;
    } | undefined>;
    /**
     * Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64"), the destination Network name or a variable (e.g.
     * "{{myvar}}")
     */
    readonly extraRoutes6: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayExtraRoutes6;
    } | undefined>;
    /**
     * Property key is the profile name
     */
    readonly idpProfiles: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayIdpProfiles;
    } | undefined>;
    /**
     * Property key is the network name
     */
    readonly ipConfigs: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayIpConfigs;
    } | undefined>;
    readonly name: pulumi.Output<string>;
    readonly networks: pulumi.Output<outputs.org.DeviceprofileGatewayNetwork[] | undefined>;
    readonly ntpOverride: pulumi.Output<boolean | undefined>;
    /**
     * List of NTP servers specific to this device. By default, those in Site Settings will be used
     */
    readonly ntpServers: pulumi.Output<string[] | undefined>;
    /**
     * Out-of-band (vme/em0/fxp0) IP config
     */
    readonly oobIpConfig: pulumi.Output<outputs.org.DeviceprofileGatewayOobIpConfig>;
    readonly orgId: pulumi.Output<string>;
    /**
     * Property key is the path name
     */
    readonly pathPreferences: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayPathPreferences;
    } | undefined>;
    /**
     * Property key is the port(s) name or range (e.g. "ge-0/0/0-10")
     */
    readonly portConfig: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayPortConfig;
    } | undefined>;
    /**
     * Auto assigned if not set
     */
    readonly routerId: pulumi.Output<string | undefined>;
    /**
     * Property key is the routing policy name
     */
    readonly routingPolicies: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayRoutingPolicies;
    } | undefined>;
    readonly servicePolicies: pulumi.Output<outputs.org.DeviceprofileGatewayServicePolicy[] | undefined>;
    /**
     * Property key is the tunnel name
     */
    readonly tunnelConfigs: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayTunnelConfigs;
    } | undefined>;
    readonly tunnelProviderOptions: pulumi.Output<outputs.org.DeviceprofileGatewayTunnelProviderOptions | undefined>;
    /**
     * Device Type. enum: `gateway`
     */
    readonly type: pulumi.Output<string>;
    readonly vrfConfig: pulumi.Output<outputs.org.DeviceprofileGatewayVrfConfig | undefined>;
    /**
     * Property key is the network name
     */
    readonly vrfInstances: pulumi.Output<{
        [key: string]: outputs.org.DeviceprofileGatewayVrfInstances;
    } | undefined>;
    /**
     * Create a DeviceprofileGateway 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: DeviceprofileGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DeviceprofileGateway resources.
 */
export interface DeviceprofileGatewayState {
    /**
     * additional CLI commands to append to the generated Junos config. **Note**: no check is done
     */
    additionalConfigCmds?: pulumi.Input<pulumi.Input<string>[]>;
    bgpConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayBgpConfig>;
    }>;
    dhcpdConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayDhcpdConfig>;
    dnsOverride?: pulumi.Input<boolean>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    dnsServers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    dnsSuffixes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Property key is the destination CIDR (e.g. "10.0.0.0/8"), the destination Network name or a variable (e.g. "{{myvar}}")
     */
    extraRoutes?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayExtraRoutes>;
    }>;
    /**
     * Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64"), the destination Network name or a variable (e.g.
     * "{{myvar}}")
     */
    extraRoutes6?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayExtraRoutes6>;
    }>;
    /**
     * Property key is the profile name
     */
    idpProfiles?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayIdpProfiles>;
    }>;
    /**
     * Property key is the network name
     */
    ipConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayIpConfigs>;
    }>;
    name?: pulumi.Input<string>;
    networks?: pulumi.Input<pulumi.Input<inputs.org.DeviceprofileGatewayNetwork>[]>;
    ntpOverride?: pulumi.Input<boolean>;
    /**
     * List of NTP servers specific to this device. By default, those in Site Settings will be used
     */
    ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Out-of-band (vme/em0/fxp0) IP config
     */
    oobIpConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayOobIpConfig>;
    orgId?: pulumi.Input<string>;
    /**
     * Property key is the path name
     */
    pathPreferences?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayPathPreferences>;
    }>;
    /**
     * Property key is the port(s) name or range (e.g. "ge-0/0/0-10")
     */
    portConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayPortConfig>;
    }>;
    /**
     * Auto assigned if not set
     */
    routerId?: pulumi.Input<string>;
    /**
     * Property key is the routing policy name
     */
    routingPolicies?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayRoutingPolicies>;
    }>;
    servicePolicies?: pulumi.Input<pulumi.Input<inputs.org.DeviceprofileGatewayServicePolicy>[]>;
    /**
     * Property key is the tunnel name
     */
    tunnelConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayTunnelConfigs>;
    }>;
    tunnelProviderOptions?: pulumi.Input<inputs.org.DeviceprofileGatewayTunnelProviderOptions>;
    /**
     * Device Type. enum: `gateway`
     */
    type?: pulumi.Input<string>;
    vrfConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayVrfConfig>;
    /**
     * Property key is the network name
     */
    vrfInstances?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayVrfInstances>;
    }>;
}
/**
 * The set of arguments for constructing a DeviceprofileGateway resource.
 */
export interface DeviceprofileGatewayArgs {
    /**
     * additional CLI commands to append to the generated Junos config. **Note**: no check is done
     */
    additionalConfigCmds?: pulumi.Input<pulumi.Input<string>[]>;
    bgpConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayBgpConfig>;
    }>;
    dhcpdConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayDhcpdConfig>;
    dnsOverride?: pulumi.Input<boolean>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    dnsServers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Global dns settings. To keep compatibility, dns settings in `ipConfig` and `oobIpConfig` will overwrite this setting
     */
    dnsSuffixes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Property key is the destination CIDR (e.g. "10.0.0.0/8"), the destination Network name or a variable (e.g. "{{myvar}}")
     */
    extraRoutes?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayExtraRoutes>;
    }>;
    /**
     * Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64"), the destination Network name or a variable (e.g.
     * "{{myvar}}")
     */
    extraRoutes6?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayExtraRoutes6>;
    }>;
    /**
     * Property key is the profile name
     */
    idpProfiles?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayIdpProfiles>;
    }>;
    /**
     * Property key is the network name
     */
    ipConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayIpConfigs>;
    }>;
    name?: pulumi.Input<string>;
    networks?: pulumi.Input<pulumi.Input<inputs.org.DeviceprofileGatewayNetwork>[]>;
    ntpOverride?: pulumi.Input<boolean>;
    /**
     * List of NTP servers specific to this device. By default, those in Site Settings will be used
     */
    ntpServers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Out-of-band (vme/em0/fxp0) IP config
     */
    oobIpConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayOobIpConfig>;
    orgId: pulumi.Input<string>;
    /**
     * Property key is the path name
     */
    pathPreferences?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayPathPreferences>;
    }>;
    /**
     * Property key is the port(s) name or range (e.g. "ge-0/0/0-10")
     */
    portConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayPortConfig>;
    }>;
    /**
     * Auto assigned if not set
     */
    routerId?: pulumi.Input<string>;
    /**
     * Property key is the routing policy name
     */
    routingPolicies?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayRoutingPolicies>;
    }>;
    servicePolicies?: pulumi.Input<pulumi.Input<inputs.org.DeviceprofileGatewayServicePolicy>[]>;
    /**
     * Property key is the tunnel name
     */
    tunnelConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayTunnelConfigs>;
    }>;
    tunnelProviderOptions?: pulumi.Input<inputs.org.DeviceprofileGatewayTunnelProviderOptions>;
    vrfConfig?: pulumi.Input<inputs.org.DeviceprofileGatewayVrfConfig>;
    /**
     * Property key is the network name
     */
    vrfInstances?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.DeviceprofileGatewayVrfInstances>;
    }>;
}