@pulumi/meraki/networks/applianceVlans.d.ts

A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * ## Example Usage
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import meraki:networks/applianceVlans:ApplianceVlans example "network_id,vlan_id"
 * ```
 */
export declare class ApplianceVlans extends pulumi.CustomResource {
    /**
     * Get an existing ApplianceVlans 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?: ApplianceVlansState, opts?: pulumi.CustomResourceOptions): ApplianceVlans;
    /**
     * Returns true if the given object is an instance of ApplianceVlans.  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 ApplianceVlans;
    /**
     * The local IP of the appliance on the VLAN
     */
    readonly applianceIp: pulumi.Output<string>;
    /**
     * CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.
     */
    readonly cidr: pulumi.Output<string | undefined>;
    /**
     * DHCP boot option for boot filename
     */
    readonly dhcpBootFilename: pulumi.Output<string>;
    /**
     * DHCP boot option to direct boot clients to the server to load the boot file from
     */
    readonly dhcpBootNextServer: pulumi.Output<string>;
    /**
     * Use DHCP boot options specified in other properties
     */
    readonly dhcpBootOptionsEnabled: pulumi.Output<boolean>;
    /**
     * The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
     */
    readonly dhcpHandling: pulumi.Output<string>;
    /**
     * The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'
     */
    readonly dhcpLeaseTime: pulumi.Output<string>;
    /**
     * The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties.
     */
    readonly dhcpOptions: pulumi.Output<outputs.networks.ApplianceVlansDhcpOption[]>;
    /**
     * The IPs of the DHCP servers that DHCP requests should be relayed to
     */
    readonly dhcpRelayServerIps: pulumi.Output<string[]>;
    /**
     * The DNS nameservers used for DHCP responses, either "upstream*dns", "google*dns", "opendns", or a newline seperated string of IP addresses or domain names
     */
    readonly dnsNameservers: pulumi.Output<string>;
    /**
     * The id of the desired group policy to apply to the VLAN
     */
    readonly groupPolicyId: pulumi.Output<string>;
    /**
     * The interface ID of the VLAN
     */
    readonly interfaceId: pulumi.Output<string>;
    /**
     * IPv6 configuration on the VLAN
     */
    readonly ipv6: pulumi.Output<outputs.networks.ApplianceVlansIpv6>;
    /**
     * Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
     */
    readonly mandatoryDhcp: pulumi.Output<outputs.networks.ApplianceVlansMandatoryDhcp>;
    /**
     * Mask used for the subnet of all bound to the template networks. Applicable only for template network.
     */
    readonly mask: pulumi.Output<number>;
    /**
     * The name of the VLAN
     */
    readonly name: pulumi.Output<string>;
    /**
     * networkId path parameter. Network ID
     */
    readonly networkId: pulumi.Output<string>;
    /**
     * The DHCP reserved IP ranges on the VLAN
     */
    readonly reservedIpRanges: pulumi.Output<outputs.networks.ApplianceVlansReservedIpRange[]>;
    /**
     * The subnet of the VLAN
     */
    readonly subnet: pulumi.Output<string>;
    /**
     * Type of subnetting of the VLAN. Applicable only for template network.
     */
    readonly templateVlanType: pulumi.Output<string>;
    /**
     * The VLAN ID of the VLAN
     */
    readonly vlanId: pulumi.Output<string>;
    /**
     * The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
     */
    readonly vpnNatSubnet: pulumi.Output<string>;
    /**
     * Create a ApplianceVlans 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: ApplianceVlansArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ApplianceVlans resources.
 */
export interface ApplianceVlansState {
    /**
     * The local IP of the appliance on the VLAN
     */
    applianceIp?: pulumi.Input<string>;
    /**
     * CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.
     */
    cidr?: pulumi.Input<string>;
    /**
     * DHCP boot option for boot filename
     */
    dhcpBootFilename?: pulumi.Input<string>;
    /**
     * DHCP boot option to direct boot clients to the server to load the boot file from
     */
    dhcpBootNextServer?: pulumi.Input<string>;
    /**
     * Use DHCP boot options specified in other properties
     */
    dhcpBootOptionsEnabled?: pulumi.Input<boolean>;
    /**
     * The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
     */
    dhcpHandling?: pulumi.Input<string>;
    /**
     * The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'
     */
    dhcpLeaseTime?: pulumi.Input<string>;
    /**
     * The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties.
     */
    dhcpOptions?: pulumi.Input<pulumi.Input<inputs.networks.ApplianceVlansDhcpOption>[]>;
    /**
     * The IPs of the DHCP servers that DHCP requests should be relayed to
     */
    dhcpRelayServerIps?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The DNS nameservers used for DHCP responses, either "upstream*dns", "google*dns", "opendns", or a newline seperated string of IP addresses or domain names
     */
    dnsNameservers?: pulumi.Input<string>;
    /**
     * The id of the desired group policy to apply to the VLAN
     */
    groupPolicyId?: pulumi.Input<string>;
    /**
     * The interface ID of the VLAN
     */
    interfaceId?: pulumi.Input<string>;
    /**
     * IPv6 configuration on the VLAN
     */
    ipv6?: pulumi.Input<inputs.networks.ApplianceVlansIpv6>;
    /**
     * Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
     */
    mandatoryDhcp?: pulumi.Input<inputs.networks.ApplianceVlansMandatoryDhcp>;
    /**
     * Mask used for the subnet of all bound to the template networks. Applicable only for template network.
     */
    mask?: pulumi.Input<number>;
    /**
     * The name of the VLAN
     */
    name?: pulumi.Input<string>;
    /**
     * networkId path parameter. Network ID
     */
    networkId?: pulumi.Input<string>;
    /**
     * The DHCP reserved IP ranges on the VLAN
     */
    reservedIpRanges?: pulumi.Input<pulumi.Input<inputs.networks.ApplianceVlansReservedIpRange>[]>;
    /**
     * The subnet of the VLAN
     */
    subnet?: pulumi.Input<string>;
    /**
     * Type of subnetting of the VLAN. Applicable only for template network.
     */
    templateVlanType?: pulumi.Input<string>;
    /**
     * The VLAN ID of the VLAN
     */
    vlanId?: pulumi.Input<string>;
    /**
     * The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
     */
    vpnNatSubnet?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ApplianceVlans resource.
 */
export interface ApplianceVlansArgs {
    /**
     * The local IP of the appliance on the VLAN
     */
    applianceIp?: pulumi.Input<string>;
    /**
     * CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN.
     */
    cidr?: pulumi.Input<string>;
    /**
     * DHCP boot option for boot filename
     */
    dhcpBootFilename?: pulumi.Input<string>;
    /**
     * DHCP boot option to direct boot clients to the server to load the boot file from
     */
    dhcpBootNextServer?: pulumi.Input<string>;
    /**
     * Use DHCP boot options specified in other properties
     */
    dhcpBootOptionsEnabled?: pulumi.Input<boolean>;
    /**
     * The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'
     */
    dhcpHandling?: pulumi.Input<string>;
    /**
     * The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'
     */
    dhcpLeaseTime?: pulumi.Input<string>;
    /**
     * The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties.
     */
    dhcpOptions?: pulumi.Input<pulumi.Input<inputs.networks.ApplianceVlansDhcpOption>[]>;
    /**
     * The IPs of the DHCP servers that DHCP requests should be relayed to
     */
    dhcpRelayServerIps?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The DNS nameservers used for DHCP responses, either "upstream*dns", "google*dns", "opendns", or a newline seperated string of IP addresses or domain names
     */
    dnsNameservers?: pulumi.Input<string>;
    /**
     * The id of the desired group policy to apply to the VLAN
     */
    groupPolicyId?: pulumi.Input<string>;
    /**
     * IPv6 configuration on the VLAN
     */
    ipv6?: pulumi.Input<inputs.networks.ApplianceVlansIpv6>;
    /**
     * Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above
     */
    mandatoryDhcp?: pulumi.Input<inputs.networks.ApplianceVlansMandatoryDhcp>;
    /**
     * Mask used for the subnet of all bound to the template networks. Applicable only for template network.
     */
    mask?: pulumi.Input<number>;
    /**
     * The name of the VLAN
     */
    name?: pulumi.Input<string>;
    /**
     * networkId path parameter. Network ID
     */
    networkId: pulumi.Input<string>;
    /**
     * The DHCP reserved IP ranges on the VLAN
     */
    reservedIpRanges?: pulumi.Input<pulumi.Input<inputs.networks.ApplianceVlansReservedIpRange>[]>;
    /**
     * The subnet of the VLAN
     */
    subnet?: pulumi.Input<string>;
    /**
     * Type of subnetting of the VLAN. Applicable only for template network.
     */
    templateVlanType?: pulumi.Input<string>;
    /**
     * The VLAN ID of the VLAN
     */
    vlanId: pulumi.Input<string>;
    /**
     * The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN
     */
    vpnNatSubnet?: pulumi.Input<string>;
}