@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
238 lines (237 loc) • 10 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = new meraki.devices.SwitchRoutingInterfacesDhcp("example", {
* bootFileName: "home_boot_file",
* bootNextServer: "1.2.3.4",
* bootOptionsEnabled: true,
* dhcpLeaseTime: "1 day",
* dhcpMode: "dhcpServer",
* dhcpOptions: [{
* code: "5",
* type: "text",
* value: "five",
* }],
* dhcpRelayServerIps: ["1.2.3.4"],
* dnsCustomNameservers: ["8.8.8.8, 8.8.4.4"],
* dnsNameserversOption: "custom",
* fixedIpAssignments: [{
* ip: "192.168.1.12",
* mac: "22:33:44:55:66:77",
* name: "Cisco Meraki valued client",
* }],
* interfaceId: "string",
* reservedIpRanges: [{
* comment: "A reserved IP range",
* end: "192.168.1.10",
* start: "192.168.1.1",
* }],
* serial: "string",
* });
* export const merakiDevicesSwitchRoutingInterfacesDhcpExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:devices/switchRoutingInterfacesDhcp:SwitchRoutingInterfacesDhcp example "interface_id,serial"
* ```
*/
export declare class SwitchRoutingInterfacesDhcp extends pulumi.CustomResource {
/**
* Get an existing SwitchRoutingInterfacesDhcp 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?: SwitchRoutingInterfacesDhcpState, opts?: pulumi.CustomResourceOptions): SwitchRoutingInterfacesDhcp;
/**
* Returns true if the given object is an instance of SwitchRoutingInterfacesDhcp. 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 SwitchRoutingInterfacesDhcp;
/**
* The PXE boot server file name for the DHCP server running on the switch stack interface
*/
readonly bootFileName: pulumi.Output<string>;
/**
* The PXE boot server IP for the DHCP server running on the switch stack interface
*/
readonly bootNextServer: pulumi.Output<string>;
/**
* Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch stack interface
*/
readonly bootOptionsEnabled: pulumi.Output<boolean>;
/**
* The DHCP lease time config for the dhcp server running on the switch stack interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week')
*/
readonly dhcpLeaseTime: pulumi.Output<string>;
/**
* The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
*/
readonly dhcpMode: pulumi.Output<string>;
/**
* Array of DHCP options consisting of code, type and value for the DHCP server running on the switch stack interface
*/
readonly dhcpOptions: pulumi.Output<outputs.devices.SwitchRoutingInterfacesDhcpDhcpOption[]>;
/**
* The DHCP relay server IPs to which DHCP packets would get relayed for the switch stack interface
*/
readonly dhcpRelayServerIps: pulumi.Output<string[]>;
/**
* The DHCP name server IPs when DHCP name server option is 'custom'
*/
readonly dnsCustomNameservers: pulumi.Output<string[]>;
/**
* The DHCP name server option for the dhcp server running on the switch stack interface ('googlePublicDns', 'openDns' or 'custom')
*/
readonly dnsNameserversOption: pulumi.Output<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
readonly fixedIpAssignments: pulumi.Output<outputs.devices.SwitchRoutingInterfacesDhcpFixedIpAssignment[]>;
/**
* interfaceId path parameter. Interface ID
*/
readonly interfaceId: pulumi.Output<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
readonly reservedIpRanges: pulumi.Output<outputs.devices.SwitchRoutingInterfacesDhcpReservedIpRange[]>;
/**
* serial path parameter.
*/
readonly serial: pulumi.Output<string>;
/**
* Create a SwitchRoutingInterfacesDhcp 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: SwitchRoutingInterfacesDhcpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SwitchRoutingInterfacesDhcp resources.
*/
export interface SwitchRoutingInterfacesDhcpState {
/**
* The PXE boot server file name for the DHCP server running on the switch stack interface
*/
bootFileName?: pulumi.Input<string>;
/**
* The PXE boot server IP for the DHCP server running on the switch stack interface
*/
bootNextServer?: pulumi.Input<string>;
/**
* Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch stack interface
*/
bootOptionsEnabled?: pulumi.Input<boolean>;
/**
* The DHCP lease time config for the dhcp server running on the switch stack interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week')
*/
dhcpLeaseTime?: pulumi.Input<string>;
/**
* The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
*/
dhcpMode?: pulumi.Input<string>;
/**
* Array of DHCP options consisting of code, type and value for the DHCP server running on the switch stack interface
*/
dhcpOptions?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpDhcpOption>[]>;
/**
* The DHCP relay server IPs to which DHCP packets would get relayed for the switch stack interface
*/
dhcpRelayServerIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DHCP name server IPs when DHCP name server option is 'custom'
*/
dnsCustomNameservers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DHCP name server option for the dhcp server running on the switch stack interface ('googlePublicDns', 'openDns' or 'custom')
*/
dnsNameserversOption?: pulumi.Input<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
fixedIpAssignments?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpFixedIpAssignment>[]>;
/**
* interfaceId path parameter. Interface ID
*/
interfaceId?: pulumi.Input<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
reservedIpRanges?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpReservedIpRange>[]>;
/**
* serial path parameter.
*/
serial?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SwitchRoutingInterfacesDhcp resource.
*/
export interface SwitchRoutingInterfacesDhcpArgs {
/**
* The PXE boot server file name for the DHCP server running on the switch stack interface
*/
bootFileName?: pulumi.Input<string>;
/**
* The PXE boot server IP for the DHCP server running on the switch stack interface
*/
bootNextServer?: pulumi.Input<string>;
/**
* Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch stack interface
*/
bootOptionsEnabled?: pulumi.Input<boolean>;
/**
* The DHCP lease time config for the dhcp server running on the switch stack interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week')
*/
dhcpLeaseTime?: pulumi.Input<string>;
/**
* The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
*/
dhcpMode?: pulumi.Input<string>;
/**
* Array of DHCP options consisting of code, type and value for the DHCP server running on the switch stack interface
*/
dhcpOptions?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpDhcpOption>[]>;
/**
* The DHCP relay server IPs to which DHCP packets would get relayed for the switch stack interface
*/
dhcpRelayServerIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DHCP name server IPs when DHCP name server option is 'custom'
*/
dnsCustomNameservers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DHCP name server option for the dhcp server running on the switch stack interface ('googlePublicDns', 'openDns' or 'custom')
*/
dnsNameserversOption?: pulumi.Input<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
fixedIpAssignments?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpFixedIpAssignment>[]>;
/**
* interfaceId path parameter. Interface ID
*/
interfaceId: pulumi.Input<string>;
/**
* Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface
*/
reservedIpRanges?: pulumi.Input<pulumi.Input<inputs.devices.SwitchRoutingInterfacesDhcpReservedIpRange>[]>;
/**
* serial path parameter.
*/
serial: pulumi.Input<string>;
}