1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. VlanAccessMap
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.VlanAccessMap

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

    This resource can manage the VLAN Access Map configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Lbrlabs.PulumiPackage.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Iosxe.VlanAccessMap("example", new()
        {
            Action = "forward",
            MatchIpAddresses = new[]
            {
                "ACL1",
            },
            MatchIpv6Addresses = new[]
            {
                "ACL2",
            },
            Sequence = 10,
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iosxe.NewVlanAccessMap(ctx, "example", &iosxe.VlanAccessMapArgs{
    			Action: pulumi.String("forward"),
    			MatchIpAddresses: pulumi.StringArray{
    				pulumi.String("ACL1"),
    			},
    			MatchIpv6Addresses: pulumi.StringArray{
    				pulumi.String("ACL2"),
    			},
    			Sequence: pulumi.Int(10),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.VlanAccessMap;
    import com.pulumi.iosxe.VlanAccessMapArgs;
    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 VlanAccessMap("example", VlanAccessMapArgs.builder()        
                .action("forward")
                .matchIpAddresses("ACL1")
                .matchIpv6Addresses("ACL2")
                .sequence(10)
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.VlanAccessMap("example",
        action="forward",
        match_ip_addresses=["ACL1"],
        match_ipv6_addresses=["ACL2"],
        sequence=10)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.VlanAccessMap("example", {
        action: "forward",
        matchIpAddresses: ["ACL1"],
        matchIpv6Addresses: ["ACL2"],
        sequence: 10,
    });
    
    resources:
      example:
        type: iosxe:VlanAccessMap
        properties:
          action: forward
          matchIpAddresses:
            - ACL1
          matchIpv6Addresses:
            - ACL2
          sequence: 10
    

    Create VlanAccessMap Resource

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

    Constructor syntax

    new VlanAccessMap(name: string, args: VlanAccessMapArgs, opts?: CustomResourceOptions);
    @overload
    def VlanAccessMap(resource_name: str,
                      args: VlanAccessMapArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def VlanAccessMap(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      sequence: Optional[int] = None,
                      action: Optional[str] = None,
                      device: Optional[str] = None,
                      match_ip_addresses: Optional[Sequence[str]] = None,
                      match_ipv6_addresses: Optional[Sequence[str]] = None,
                      name: Optional[str] = None)
    func NewVlanAccessMap(ctx *Context, name string, args VlanAccessMapArgs, opts ...ResourceOption) (*VlanAccessMap, error)
    public VlanAccessMap(string name, VlanAccessMapArgs args, CustomResourceOptions? opts = null)
    public VlanAccessMap(String name, VlanAccessMapArgs args)
    public VlanAccessMap(String name, VlanAccessMapArgs args, CustomResourceOptions options)
    
    type: iosxe:VlanAccessMap
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VlanAccessMapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VlanAccessMapArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VlanAccessMapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VlanAccessMapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VlanAccessMapArgs
    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 vlanAccessMapResource = new Iosxe.VlanAccessMap("vlanAccessMapResource", new()
    {
        Sequence = 0,
        Action = "string",
        Device = "string",
        MatchIpAddresses = new[]
        {
            "string",
        },
        MatchIpv6Addresses = new[]
        {
            "string",
        },
        Name = "string",
    });
    
    example, err := iosxe.NewVlanAccessMap(ctx, "vlanAccessMapResource", &iosxe.VlanAccessMapArgs{
    	Sequence: pulumi.Int(0),
    	Action:   pulumi.String("string"),
    	Device:   pulumi.String("string"),
    	MatchIpAddresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	MatchIpv6Addresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var vlanAccessMapResource = new VlanAccessMap("vlanAccessMapResource", VlanAccessMapArgs.builder()
        .sequence(0)
        .action("string")
        .device("string")
        .matchIpAddresses("string")
        .matchIpv6Addresses("string")
        .name("string")
        .build());
    
    vlan_access_map_resource = iosxe.VlanAccessMap("vlanAccessMapResource",
        sequence=0,
        action="string",
        device="string",
        match_ip_addresses=["string"],
        match_ipv6_addresses=["string"],
        name="string")
    
    const vlanAccessMapResource = new iosxe.VlanAccessMap("vlanAccessMapResource", {
        sequence: 0,
        action: "string",
        device: "string",
        matchIpAddresses: ["string"],
        matchIpv6Addresses: ["string"],
        name: "string",
    });
    
    type: iosxe:VlanAccessMap
    properties:
        action: string
        device: string
        matchIpAddresses:
            - string
        matchIpv6Addresses:
            - string
        name: string
        sequence: 0
    

    VlanAccessMap 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 VlanAccessMap resource accepts the following input properties:

    Sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    Action string
    Take the action - Choices: drop, forward
    Device string
    A device name from the provider configuration.
    MatchIpAddresses List<string>
    MatchIpv6Addresses List<string>
    Match IPv6 address to access control.
    Name string
    Vlan access map tag
    Sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    Action string
    Take the action - Choices: drop, forward
    Device string
    A device name from the provider configuration.
    MatchIpAddresses []string
    MatchIpv6Addresses []string
    Match IPv6 address to access control.
    Name string
    Vlan access map tag
    sequence Integer
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action String
    Take the action - Choices: drop, forward
    device String
    A device name from the provider configuration.
    matchIpAddresses List<String>
    matchIpv6Addresses List<String>
    Match IPv6 address to access control.
    name String
    Vlan access map tag
    sequence number
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action string
    Take the action - Choices: drop, forward
    device string
    A device name from the provider configuration.
    matchIpAddresses string[]
    matchIpv6Addresses string[]
    Match IPv6 address to access control.
    name string
    Vlan access map tag
    sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action str
    Take the action - Choices: drop, forward
    device str
    A device name from the provider configuration.
    match_ip_addresses Sequence[str]
    match_ipv6_addresses Sequence[str]
    Match IPv6 address to access control.
    name str
    Vlan access map tag
    sequence Number
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action String
    Take the action - Choices: drop, forward
    device String
    A device name from the provider configuration.
    matchIpAddresses List<String>
    matchIpv6Addresses List<String>
    Match IPv6 address to access control.
    name String
    Vlan access map tag

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VlanAccessMap Resource

    Get an existing VlanAccessMap 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?: VlanAccessMapState, opts?: CustomResourceOptions): VlanAccessMap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            device: Optional[str] = None,
            match_ip_addresses: Optional[Sequence[str]] = None,
            match_ipv6_addresses: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            sequence: Optional[int] = None) -> VlanAccessMap
    func GetVlanAccessMap(ctx *Context, name string, id IDInput, state *VlanAccessMapState, opts ...ResourceOption) (*VlanAccessMap, error)
    public static VlanAccessMap Get(string name, Input<string> id, VlanAccessMapState? state, CustomResourceOptions? opts = null)
    public static VlanAccessMap get(String name, Output<String> id, VlanAccessMapState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Action string
    Take the action - Choices: drop, forward
    Device string
    A device name from the provider configuration.
    MatchIpAddresses List<string>
    MatchIpv6Addresses List<string>
    Match IPv6 address to access control.
    Name string
    Vlan access map tag
    Sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    Action string
    Take the action - Choices: drop, forward
    Device string
    A device name from the provider configuration.
    MatchIpAddresses []string
    MatchIpv6Addresses []string
    Match IPv6 address to access control.
    Name string
    Vlan access map tag
    Sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action String
    Take the action - Choices: drop, forward
    device String
    A device name from the provider configuration.
    matchIpAddresses List<String>
    matchIpv6Addresses List<String>
    Match IPv6 address to access control.
    name String
    Vlan access map tag
    sequence Integer
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action string
    Take the action - Choices: drop, forward
    device string
    A device name from the provider configuration.
    matchIpAddresses string[]
    matchIpv6Addresses string[]
    Match IPv6 address to access control.
    name string
    Vlan access map tag
    sequence number
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action str
    Take the action - Choices: drop, forward
    device str
    A device name from the provider configuration.
    match_ip_addresses Sequence[str]
    match_ipv6_addresses Sequence[str]
    Match IPv6 address to access control.
    name str
    Vlan access map tag
    sequence int
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535
    action String
    Take the action - Choices: drop, forward
    device String
    A device name from the provider configuration.
    matchIpAddresses List<String>
    matchIpv6Addresses List<String>
    Match IPv6 address to access control.
    name String
    Vlan access map tag
    sequence Number
    Sequence to insert to/delete from existing vlan access-map entry - Range: 0-65535

    Import

     $ pulumi import iosxe:index/vlanAccessMap:VlanAccessMap example "Cisco-IOS-XE-native:native/vlan/Cisco-IOS-XE-vlan:access-map=VAM1,10"
    

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

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs