1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. networks
  5. AppliancePorts
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.AppliancePorts

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = new meraki.networks.AppliancePorts("example", {
    accessPolicy: "open",
    allowedVlans: "all",
    dropUntaggedTraffic: false,
    enabled: true,
    networkId: "string",
    portId: "string",
    type: "access",
    vlan: 3,
});
export const merakiNetworksAppliancePortsExample = example;
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.networks.AppliancePorts("example",
    access_policy="open",
    allowed_vlans="all",
    drop_untagged_traffic=False,
    enabled=True,
    network_id="string",
    port_id="string",
    type="access",
    vlan=3)
pulumi.export("merakiNetworksAppliancePortsExample", example)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.NewAppliancePorts(ctx, "example", &networks.AppliancePortsArgs{
			AccessPolicy:        pulumi.String("open"),
			AllowedVlans:        pulumi.String("all"),
			DropUntaggedTraffic: pulumi.Bool(false),
			Enabled:             pulumi.Bool(true),
			NetworkId:           pulumi.String("string"),
			PortId:              pulumi.String("string"),
			Type:                pulumi.String("access"),
			Vlan:                pulumi.Int(3),
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksAppliancePortsExample", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Networks.AppliancePorts("example", new()
    {
        AccessPolicy = "open",
        AllowedVlans = "all",
        DropUntaggedTraffic = false,
        Enabled = true,
        NetworkId = "string",
        PortId = "string",
        Type = "access",
        Vlan = 3,
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksAppliancePortsExample"] = example,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.AppliancePorts;
import com.pulumi.meraki.networks.AppliancePortsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AppliancePorts("example", AppliancePortsArgs.builder()
            .accessPolicy("open")
            .allowedVlans("all")
            .dropUntaggedTraffic(false)
            .enabled(true)
            .networkId("string")
            .portId("string")
            .type("access")
            .vlan(3)
            .build());

        ctx.export("merakiNetworksAppliancePortsExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:networks:AppliancePorts
    properties:
      accessPolicy: open
      allowedVlans: all
      dropUntaggedTraffic: false
      enabled: true
      networkId: string
      portId: string
      type: access
      vlan: 3
outputs:
  merakiNetworksAppliancePortsExample: ${example}
Copy

Create AppliancePorts Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AppliancePorts(name: string, args: AppliancePortsArgs, opts?: CustomResourceOptions);
@overload
def AppliancePorts(resource_name: str,
                   args: AppliancePortsArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def AppliancePorts(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   network_id: Optional[str] = None,
                   port_id: Optional[str] = None,
                   access_policy: Optional[str] = None,
                   allowed_vlans: Optional[str] = None,
                   drop_untagged_traffic: Optional[bool] = None,
                   enabled: Optional[bool] = None,
                   type: Optional[str] = None,
                   vlan: Optional[int] = None)
func NewAppliancePorts(ctx *Context, name string, args AppliancePortsArgs, opts ...ResourceOption) (*AppliancePorts, error)
public AppliancePorts(string name, AppliancePortsArgs args, CustomResourceOptions? opts = null)
public AppliancePorts(String name, AppliancePortsArgs args)
public AppliancePorts(String name, AppliancePortsArgs args, CustomResourceOptions options)
type: meraki:networks:AppliancePorts
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AppliancePortsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AppliancePortsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AppliancePortsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AppliancePortsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppliancePortsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var appliancePortsResource = new Meraki.Networks.AppliancePorts("appliancePortsResource", new()
{
    NetworkId = "string",
    PortId = "string",
    AccessPolicy = "string",
    AllowedVlans = "string",
    DropUntaggedTraffic = false,
    Enabled = false,
    Type = "string",
    Vlan = 0,
});
Copy
example, err := networks.NewAppliancePorts(ctx, "appliancePortsResource", &networks.AppliancePortsArgs{
	NetworkId:           pulumi.String("string"),
	PortId:              pulumi.String("string"),
	AccessPolicy:        pulumi.String("string"),
	AllowedVlans:        pulumi.String("string"),
	DropUntaggedTraffic: pulumi.Bool(false),
	Enabled:             pulumi.Bool(false),
	Type:                pulumi.String("string"),
	Vlan:                pulumi.Int(0),
})
Copy
var appliancePortsResource = new AppliancePorts("appliancePortsResource", AppliancePortsArgs.builder()
    .networkId("string")
    .portId("string")
    .accessPolicy("string")
    .allowedVlans("string")
    .dropUntaggedTraffic(false)
    .enabled(false)
    .type("string")
    .vlan(0)
    .build());
Copy
appliance_ports_resource = meraki.networks.AppliancePorts("appliancePortsResource",
    network_id="string",
    port_id="string",
    access_policy="string",
    allowed_vlans="string",
    drop_untagged_traffic=False,
    enabled=False,
    type="string",
    vlan=0)
Copy
const appliancePortsResource = new meraki.networks.AppliancePorts("appliancePortsResource", {
    networkId: "string",
    portId: "string",
    accessPolicy: "string",
    allowedVlans: "string",
    dropUntaggedTraffic: false,
    enabled: false,
    type: "string",
    vlan: 0,
});
Copy
type: meraki:networks:AppliancePorts
properties:
    accessPolicy: string
    allowedVlans: string
    dropUntaggedTraffic: false
    enabled: false
    networkId: string
    portId: string
    type: string
    vlan: 0
Copy

AppliancePorts Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AppliancePorts resource accepts the following input properties:

NetworkId This property is required. string
networkId path parameter. Network ID
PortId This property is required. string
portId path parameter. Port ID
AccessPolicy string
The name of the policy. Only applicable to Access ports.
AllowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
DropUntaggedTraffic bool
Whether the trunk port can drop all untagged traffic.
Enabled bool
The status of the port
Type string
The type of the port: 'access' or 'trunk'.
Vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
NetworkId This property is required. string
networkId path parameter. Network ID
PortId This property is required. string
portId path parameter. Port ID
AccessPolicy string
The name of the policy. Only applicable to Access ports.
AllowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
DropUntaggedTraffic bool
Whether the trunk port can drop all untagged traffic.
Enabled bool
The status of the port
Type string
The type of the port: 'access' or 'trunk'.
Vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
networkId This property is required. String
networkId path parameter. Network ID
portId This property is required. String
portId path parameter. Port ID
accessPolicy String
The name of the policy. Only applicable to Access ports.
allowedVlans String
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic Boolean
Whether the trunk port can drop all untagged traffic.
enabled Boolean
The status of the port
type String
The type of the port: 'access' or 'trunk'.
vlan Integer
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
networkId This property is required. string
networkId path parameter. Network ID
portId This property is required. string
portId path parameter. Port ID
accessPolicy string
The name of the policy. Only applicable to Access ports.
allowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic boolean
Whether the trunk port can drop all untagged traffic.
enabled boolean
The status of the port
type string
The type of the port: 'access' or 'trunk'.
vlan number
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
network_id This property is required. str
networkId path parameter. Network ID
port_id This property is required. str
portId path parameter. Port ID
access_policy str
The name of the policy. Only applicable to Access ports.
allowed_vlans str
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
drop_untagged_traffic bool
Whether the trunk port can drop all untagged traffic.
enabled bool
The status of the port
type str
The type of the port: 'access' or 'trunk'.
vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
networkId This property is required. String
networkId path parameter. Network ID
portId This property is required. String
portId path parameter. Port ID
accessPolicy String
The name of the policy. Only applicable to Access ports.
allowedVlans String
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic Boolean
Whether the trunk port can drop all untagged traffic.
enabled Boolean
The status of the port
type String
The type of the port: 'access' or 'trunk'.
vlan Number
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.

Outputs

All input properties are implicitly available as output properties. Additionally, the AppliancePorts resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Number int
Number of the port
Id string
The provider-assigned unique ID for this managed resource.
Number int
Number of the port
id String
The provider-assigned unique ID for this managed resource.
number Integer
Number of the port
id string
The provider-assigned unique ID for this managed resource.
number number
Number of the port
id str
The provider-assigned unique ID for this managed resource.
number int
Number of the port
id String
The provider-assigned unique ID for this managed resource.
number Number
Number of the port

Look up Existing AppliancePorts Resource

Get an existing AppliancePorts resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppliancePortsState, opts?: CustomResourceOptions): AppliancePorts
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_policy: Optional[str] = None,
        allowed_vlans: Optional[str] = None,
        drop_untagged_traffic: Optional[bool] = None,
        enabled: Optional[bool] = None,
        network_id: Optional[str] = None,
        number: Optional[int] = None,
        port_id: Optional[str] = None,
        type: Optional[str] = None,
        vlan: Optional[int] = None) -> AppliancePorts
func GetAppliancePorts(ctx *Context, name string, id IDInput, state *AppliancePortsState, opts ...ResourceOption) (*AppliancePorts, error)
public static AppliancePorts Get(string name, Input<string> id, AppliancePortsState? state, CustomResourceOptions? opts = null)
public static AppliancePorts get(String name, Output<String> id, AppliancePortsState state, CustomResourceOptions options)
resources:  _:    type: meraki:networks:AppliancePorts    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessPolicy string
The name of the policy. Only applicable to Access ports.
AllowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
DropUntaggedTraffic bool
Whether the trunk port can drop all untagged traffic.
Enabled bool
The status of the port
NetworkId string
networkId path parameter. Network ID
Number int
Number of the port
PortId string
portId path parameter. Port ID
Type string
The type of the port: 'access' or 'trunk'.
Vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
AccessPolicy string
The name of the policy. Only applicable to Access ports.
AllowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
DropUntaggedTraffic bool
Whether the trunk port can drop all untagged traffic.
Enabled bool
The status of the port
NetworkId string
networkId path parameter. Network ID
Number int
Number of the port
PortId string
portId path parameter. Port ID
Type string
The type of the port: 'access' or 'trunk'.
Vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
accessPolicy String
The name of the policy. Only applicable to Access ports.
allowedVlans String
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic Boolean
Whether the trunk port can drop all untagged traffic.
enabled Boolean
The status of the port
networkId String
networkId path parameter. Network ID
number Integer
Number of the port
portId String
portId path parameter. Port ID
type String
The type of the port: 'access' or 'trunk'.
vlan Integer
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
accessPolicy string
The name of the policy. Only applicable to Access ports.
allowedVlans string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic boolean
Whether the trunk port can drop all untagged traffic.
enabled boolean
The status of the port
networkId string
networkId path parameter. Network ID
number number
Number of the port
portId string
portId path parameter. Port ID
type string
The type of the port: 'access' or 'trunk'.
vlan number
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
access_policy str
The name of the policy. Only applicable to Access ports.
allowed_vlans str
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
drop_untagged_traffic bool
Whether the trunk port can drop all untagged traffic.
enabled bool
The status of the port
network_id str
networkId path parameter. Network ID
number int
Number of the port
port_id str
portId path parameter. Port ID
type str
The type of the port: 'access' or 'trunk'.
vlan int
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.
accessPolicy String
The name of the policy. Only applicable to Access ports.
allowedVlans String
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
dropUntaggedTraffic Boolean
Whether the trunk port can drop all untagged traffic.
enabled Boolean
The status of the port
networkId String
networkId path parameter. Network ID
number Number
Number of the port
portId String
portId path parameter. Port ID
type String
The type of the port: 'access' or 'trunk'.
vlan Number
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.

Import

$ pulumi import meraki:networks/appliancePorts:AppliancePorts example "network_id,port_id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.