@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
445 lines (444 loc) • 16.6 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.organizations.ConfigTemplatesSwitchProfilesPorts("example", {
* accessPolicyNumber: 2,
* accessPolicyType: "Sticky MAC allow list",
* allowedVlans: "1,3,5-10",
* configTemplateId: "string",
* daiTrusted: false,
* enabled: true,
* flexibleStackingEnabled: true,
* isolationEnabled: false,
* linkNegotiation: "Auto negotiate",
* macAllowLists: [
* "34:56:fe:ce:8e:b0",
* "34:56:fe:ce:8e:b1",
* ],
* name: "My switch port",
* organizationId: "string",
* poeEnabled: true,
* portId: "string",
* portScheduleId: "1234",
* profile: {
* enabled: false,
* id: "1284392014819",
* iname: "iname",
* },
* profileId: "string",
* rstpEnabled: true,
* stickyMacAllowLists: [
* "34:56:fe:ce:8e:b0",
* "34:56:fe:ce:8e:b1",
* ],
* stickyMacAllowListLimit: 5,
* stormControlEnabled: true,
* stpGuard: "disabled",
* tags: [
* "tag1",
* "tag2",
* ],
* type: "access",
* udld: "Alert only",
* vlan: 10,
* voiceVlan: 20,
* });
* export const merakiOrganizationsConfigTemplatesSwitchProfilesPortsExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:organizations/configTemplatesSwitchProfilesPorts:ConfigTemplatesSwitchProfilesPorts example "config_template_id,organization_id,port_id,profile_id"
* ```
*/
export declare class ConfigTemplatesSwitchProfilesPorts extends pulumi.CustomResource {
/**
* Get an existing ConfigTemplatesSwitchProfilesPorts 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?: ConfigTemplatesSwitchProfilesPortsState, opts?: pulumi.CustomResourceOptions): ConfigTemplatesSwitchProfilesPorts;
/**
* Returns true if the given object is an instance of ConfigTemplatesSwitchProfilesPorts. 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 ConfigTemplatesSwitchProfilesPorts;
/**
* The number of a custom access policy to configure on the switch template port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
*/
readonly accessPolicyNumber: pulumi.Output<number>;
/**
* The type of the access policy of the switch template port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
*/
readonly accessPolicyType: pulumi.Output<string>;
/**
* The VLANs allowed on the switch template port. Only applicable to trunk ports.
*/
readonly allowedVlans: pulumi.Output<string>;
/**
* configTemplateId path parameter. Config template ID
*/
readonly configTemplateId: pulumi.Output<string>;
/**
* If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
*/
readonly daiTrusted: pulumi.Output<boolean>;
/**
* The status of the switch template port.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
*/
readonly flexibleStackingEnabled: pulumi.Output<boolean>;
/**
* The isolation status of the switch template port.
*/
readonly isolationEnabled: pulumi.Output<boolean>;
/**
* The link speed for the switch template port.
*/
readonly linkNegotiation: pulumi.Output<string>;
/**
* Available link speeds for the switch template port.
*/
readonly linkNegotiationCapabilities: pulumi.Output<string[]>;
/**
* Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
*/
readonly macAllowLists: pulumi.Output<string[]>;
/**
* Port mirror
*/
readonly mirror: pulumi.Output<outputs.organizations.ConfigTemplatesSwitchProfilesPortsMirror>;
/**
* Expansion module
*/
readonly module: pulumi.Output<outputs.organizations.ConfigTemplatesSwitchProfilesPortsModule>;
/**
* The name of the switch template port.
*/
readonly name: pulumi.Output<string>;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* The PoE status of the switch template port.
*/
readonly poeEnabled: pulumi.Output<boolean>;
/**
* The identifier of the switch template port.
*/
readonly portId: pulumi.Output<string>;
/**
* The ID of the port schedule. A value of null will clear the port schedule.
*/
readonly portScheduleId: pulumi.Output<string>;
/**
* Profile attributes
*/
readonly profile: pulumi.Output<outputs.organizations.ConfigTemplatesSwitchProfilesPortsProfile>;
/**
* profileId path parameter. Profile ID
*/
readonly profileId: pulumi.Output<string>;
/**
* The rapid spanning tree protocol status.
*/
readonly rstpEnabled: pulumi.Output<boolean>;
/**
* The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
readonly stickyMacAllowListLimit: pulumi.Output<number>;
/**
* The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
readonly stickyMacAllowLists: pulumi.Output<string[]>;
/**
* The storm control status of the switch template port.
*/
readonly stormControlEnabled: pulumi.Output<boolean>;
/**
* The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
*/
readonly stpGuard: pulumi.Output<string>;
/**
* The list of tags of the switch template port.
*/
readonly tags: pulumi.Output<string[]>;
/**
* The type of the switch template port ('trunk' or 'access').
*/
readonly type: pulumi.Output<string>;
/**
* The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
*/
readonly udld: pulumi.Output<string>;
/**
* The VLAN of the switch template port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
*/
readonly vlan: pulumi.Output<number>;
/**
* The voice VLAN of the switch template port. Only applicable to access ports.
*/
readonly voiceVlan: pulumi.Output<number>;
/**
* Create a ConfigTemplatesSwitchProfilesPorts 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: ConfigTemplatesSwitchProfilesPortsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConfigTemplatesSwitchProfilesPorts resources.
*/
export interface ConfigTemplatesSwitchProfilesPortsState {
/**
* The number of a custom access policy to configure on the switch template port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
*/
accessPolicyNumber?: pulumi.Input<number>;
/**
* The type of the access policy of the switch template port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
*/
accessPolicyType?: pulumi.Input<string>;
/**
* The VLANs allowed on the switch template port. Only applicable to trunk ports.
*/
allowedVlans?: pulumi.Input<string>;
/**
* configTemplateId path parameter. Config template ID
*/
configTemplateId?: pulumi.Input<string>;
/**
* If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
*/
daiTrusted?: pulumi.Input<boolean>;
/**
* The status of the switch template port.
*/
enabled?: pulumi.Input<boolean>;
/**
* For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
*/
flexibleStackingEnabled?: pulumi.Input<boolean>;
/**
* The isolation status of the switch template port.
*/
isolationEnabled?: pulumi.Input<boolean>;
/**
* The link speed for the switch template port.
*/
linkNegotiation?: pulumi.Input<string>;
/**
* Available link speeds for the switch template port.
*/
linkNegotiationCapabilities?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
*/
macAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Port mirror
*/
mirror?: pulumi.Input<inputs.organizations.ConfigTemplatesSwitchProfilesPortsMirror>;
/**
* Expansion module
*/
module?: pulumi.Input<inputs.organizations.ConfigTemplatesSwitchProfilesPortsModule>;
/**
* The name of the switch template port.
*/
name?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* The PoE status of the switch template port.
*/
poeEnabled?: pulumi.Input<boolean>;
/**
* The identifier of the switch template port.
*/
portId?: pulumi.Input<string>;
/**
* The ID of the port schedule. A value of null will clear the port schedule.
*/
portScheduleId?: pulumi.Input<string>;
/**
* Profile attributes
*/
profile?: pulumi.Input<inputs.organizations.ConfigTemplatesSwitchProfilesPortsProfile>;
/**
* profileId path parameter. Profile ID
*/
profileId?: pulumi.Input<string>;
/**
* The rapid spanning tree protocol status.
*/
rstpEnabled?: pulumi.Input<boolean>;
/**
* The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
stickyMacAllowListLimit?: pulumi.Input<number>;
/**
* The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
stickyMacAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The storm control status of the switch template port.
*/
stormControlEnabled?: pulumi.Input<boolean>;
/**
* The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
*/
stpGuard?: pulumi.Input<string>;
/**
* The list of tags of the switch template port.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the switch template port ('trunk' or 'access').
*/
type?: pulumi.Input<string>;
/**
* The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
*/
udld?: pulumi.Input<string>;
/**
* The VLAN of the switch template port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
*/
vlan?: pulumi.Input<number>;
/**
* The voice VLAN of the switch template port. Only applicable to access ports.
*/
voiceVlan?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ConfigTemplatesSwitchProfilesPorts resource.
*/
export interface ConfigTemplatesSwitchProfilesPortsArgs {
/**
* The number of a custom access policy to configure on the switch template port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
*/
accessPolicyNumber?: pulumi.Input<number>;
/**
* The type of the access policy of the switch template port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
*/
accessPolicyType?: pulumi.Input<string>;
/**
* The VLANs allowed on the switch template port. Only applicable to trunk ports.
*/
allowedVlans?: pulumi.Input<string>;
/**
* configTemplateId path parameter. Config template ID
*/
configTemplateId: pulumi.Input<string>;
/**
* If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
*/
daiTrusted?: pulumi.Input<boolean>;
/**
* The status of the switch template port.
*/
enabled?: pulumi.Input<boolean>;
/**
* For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
*/
flexibleStackingEnabled?: pulumi.Input<boolean>;
/**
* The isolation status of the switch template port.
*/
isolationEnabled?: pulumi.Input<boolean>;
/**
* The link speed for the switch template port.
*/
linkNegotiation?: pulumi.Input<string>;
/**
* Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
*/
macAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the switch template port.
*/
name?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
/**
* The PoE status of the switch template port.
*/
poeEnabled?: pulumi.Input<boolean>;
/**
* The identifier of the switch template port.
*/
portId: pulumi.Input<string>;
/**
* The ID of the port schedule. A value of null will clear the port schedule.
*/
portScheduleId?: pulumi.Input<string>;
/**
* Profile attributes
*/
profile?: pulumi.Input<inputs.organizations.ConfigTemplatesSwitchProfilesPortsProfile>;
/**
* profileId path parameter. Profile ID
*/
profileId: pulumi.Input<string>;
/**
* The rapid spanning tree protocol status.
*/
rstpEnabled?: pulumi.Input<boolean>;
/**
* The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
stickyMacAllowListLimit?: pulumi.Input<number>;
/**
* The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
*/
stickyMacAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The storm control status of the switch template port.
*/
stormControlEnabled?: pulumi.Input<boolean>;
/**
* The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
*/
stpGuard?: pulumi.Input<string>;
/**
* The list of tags of the switch template port.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the switch template port ('trunk' or 'access').
*/
type?: pulumi.Input<string>;
/**
* The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
*/
udld?: pulumi.Input<string>;
/**
* The VLAN of the switch template port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
*/
vlan?: pulumi.Input<number>;
/**
* The voice VLAN of the switch template port. Only applicable to access ports.
*/
voiceVlan?: pulumi.Input<number>;
}