@pulumi/juniper-mist/org/gatewaytemplate.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 Templates.
 *
 * A Gateway template is used to define the static ip address and subnet mask of the hub device, along with the gateway. It also allows for the selection of options such as enabling source nat and overriding the public ip for the hub if needed. the endpoint selected in the gateway template ties the hub and spoke devices together and creates the auto-vpn tunnel.
 *
 * ## Import
 *
 * Using `pulumi import`, import `mist_org_gatewaytemplate` with:
 *
 * Gateway Template can be imported by specifying the org_id and the gatewaytemplate_id
 *
 * ```sh
 * $ pulumi import junipermist:org/gatewaytemplate:Gatewaytemplate gatewaytemplate_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
 * ```
 */
export declare class Gatewaytemplate extends pulumi.CustomResource {
    /**
     * Get an existing Gatewaytemplate 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?: GatewaytemplateState, opts?: pulumi.CustomResourceOptions): Gatewaytemplate;
    /**
     * Returns true if the given object is an instance of Gatewaytemplate.  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 Gatewaytemplate;
    /**
     * 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.GatewaytemplateBgpConfig;
    } | undefined>;
    readonly dhcpdConfig: pulumi.Output<outputs.org.GatewaytemplateDhcpdConfig | 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.GatewaytemplateExtraRoutes;
    } | 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.GatewaytemplateExtraRoutes6;
    } | undefined>;
    /**
     * Property key is the profile name
     */
    readonly idpProfiles: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplateIdpProfiles;
    } | undefined>;
    /**
     * Property key is the network name
     */
    readonly ipConfigs: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplateIpConfigs;
    } | undefined>;
    readonly name: pulumi.Output<string>;
    readonly networks: pulumi.Output<outputs.org.GatewaytemplateNetwork[] | 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.GatewaytemplateOobIpConfig>;
    readonly orgId: pulumi.Output<string>;
    /**
     * Property key is the path name
     */
    readonly pathPreferences: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplatePathPreferences;
    } | undefined>;
    /**
     * Property key is the Port Name (i.e. "ge-0/0/0"), the Ports Range (i.e. "ge-0/0/0-10"), the List of Ports (i.e.
     * "ge-0/0/0,ge-1/0/0", only allowed for Aggregated or Redundant interfaces) or a Variable (i.e. "{{myvar}}").
     */
    readonly portConfig: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplatePortConfig;
    } | 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.GatewaytemplateRoutingPolicies;
    } | undefined>;
    readonly servicePolicies: pulumi.Output<outputs.org.GatewaytemplateServicePolicy[] | undefined>;
    /**
     * Property key is the tunnel name
     */
    readonly tunnelConfigs: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplateTunnelConfigs;
    } | undefined>;
    readonly tunnelProviderOptions: pulumi.Output<outputs.org.GatewaytemplateTunnelProviderOptions | undefined>;
    /**
     * enum: `spoke`, `standalone`
     */
    readonly type: pulumi.Output<string>;
    readonly vrfConfig: pulumi.Output<outputs.org.GatewaytemplateVrfConfig | undefined>;
    /**
     * Property key is the network name
     */
    readonly vrfInstances: pulumi.Output<{
        [key: string]: outputs.org.GatewaytemplateVrfInstances;
    } | undefined>;
    /**
     * Create a Gatewaytemplate 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: GatewaytemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Gatewaytemplate resources.
 */
export interface GatewaytemplateState {
    /**
     * 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.GatewaytemplateBgpConfig>;
    }>;
    dhcpdConfig?: pulumi.Input<inputs.org.GatewaytemplateDhcpdConfig>;
    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.GatewaytemplateExtraRoutes>;
    }>;
    /**
     * 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.GatewaytemplateExtraRoutes6>;
    }>;
    /**
     * Property key is the profile name
     */
    idpProfiles?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateIdpProfiles>;
    }>;
    /**
     * Property key is the network name
     */
    ipConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateIpConfigs>;
    }>;
    name?: pulumi.Input<string>;
    networks?: pulumi.Input<pulumi.Input<inputs.org.GatewaytemplateNetwork>[]>;
    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.GatewaytemplateOobIpConfig>;
    orgId?: pulumi.Input<string>;
    /**
     * Property key is the path name
     */
    pathPreferences?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplatePathPreferences>;
    }>;
    /**
     * Property key is the Port Name (i.e. "ge-0/0/0"), the Ports Range (i.e. "ge-0/0/0-10"), the List of Ports (i.e.
     * "ge-0/0/0,ge-1/0/0", only allowed for Aggregated or Redundant interfaces) or a Variable (i.e. "{{myvar}}").
     */
    portConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplatePortConfig>;
    }>;
    /**
     * 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.GatewaytemplateRoutingPolicies>;
    }>;
    servicePolicies?: pulumi.Input<pulumi.Input<inputs.org.GatewaytemplateServicePolicy>[]>;
    /**
     * Property key is the tunnel name
     */
    tunnelConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateTunnelConfigs>;
    }>;
    tunnelProviderOptions?: pulumi.Input<inputs.org.GatewaytemplateTunnelProviderOptions>;
    /**
     * enum: `spoke`, `standalone`
     */
    type?: pulumi.Input<string>;
    vrfConfig?: pulumi.Input<inputs.org.GatewaytemplateVrfConfig>;
    /**
     * Property key is the network name
     */
    vrfInstances?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateVrfInstances>;
    }>;
}
/**
 * The set of arguments for constructing a Gatewaytemplate resource.
 */
export interface GatewaytemplateArgs {
    /**
     * 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.GatewaytemplateBgpConfig>;
    }>;
    dhcpdConfig?: pulumi.Input<inputs.org.GatewaytemplateDhcpdConfig>;
    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.GatewaytemplateExtraRoutes>;
    }>;
    /**
     * 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.GatewaytemplateExtraRoutes6>;
    }>;
    /**
     * Property key is the profile name
     */
    idpProfiles?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateIdpProfiles>;
    }>;
    /**
     * Property key is the network name
     */
    ipConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateIpConfigs>;
    }>;
    name?: pulumi.Input<string>;
    networks?: pulumi.Input<pulumi.Input<inputs.org.GatewaytemplateNetwork>[]>;
    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.GatewaytemplateOobIpConfig>;
    orgId: pulumi.Input<string>;
    /**
     * Property key is the path name
     */
    pathPreferences?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplatePathPreferences>;
    }>;
    /**
     * Property key is the Port Name (i.e. "ge-0/0/0"), the Ports Range (i.e. "ge-0/0/0-10"), the List of Ports (i.e.
     * "ge-0/0/0,ge-1/0/0", only allowed for Aggregated or Redundant interfaces) or a Variable (i.e. "{{myvar}}").
     */
    portConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplatePortConfig>;
    }>;
    /**
     * 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.GatewaytemplateRoutingPolicies>;
    }>;
    servicePolicies?: pulumi.Input<pulumi.Input<inputs.org.GatewaytemplateServicePolicy>[]>;
    /**
     * Property key is the tunnel name
     */
    tunnelConfigs?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateTunnelConfigs>;
    }>;
    tunnelProviderOptions?: pulumi.Input<inputs.org.GatewaytemplateTunnelProviderOptions>;
    /**
     * enum: `spoke`, `standalone`
     */
    type?: pulumi.Input<string>;
    vrfConfig?: pulumi.Input<inputs.org.GatewaytemplateVrfConfig>;
    /**
     * Property key is the network name
     */
    vrfInstances?: pulumi.Input<{
        [key: string]: pulumi.Input<inputs.org.GatewaytemplateVrfInstances>;
    }>;
}