Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. devices
  5. ManagementInterface
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.devices.ManagementInterface

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.devices.ManagementInterface;
import com.pulumi.meraki.devices.ManagementInterfaceArgs;
import com.pulumi.meraki.devices.inputs.ManagementInterfaceWan1Args;
import com.pulumi.meraki.devices.inputs.ManagementInterfaceWan2Args;
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 ManagementInterface("example", ManagementInterfaceArgs.builder()
            .serial("string")
            .wan1(ManagementInterfaceWan1Args.builder()
                .static_dns(                
                    "1.2.3.2",
                    "1.2.3.3")
                .static_gateway_ip("1.2.3.1")
                .static_ip("1.2.3.4")
                .static_subnet_mask("255.255.255.0")
                .using_static_ip(true)
                .vlan(7)
                .wan_enabled("not configured")
                .build())
            .wan2(ManagementInterfaceWan2Args.builder()
                .static_dns(                
                    "1.2.3.2",
                    "1.2.3.3")
                .static_gateway_ip("1.2.3.1")
                .static_ip("1.2.3.4")
                .static_subnet_mask("255.255.255.0")
                .using_static_ip(false)
                .vlan(2)
                .wan_enabled("enabled")
                .build())
            .build());

        ctx.export("merakiDevicesManagementInterfaceExample", example);
    }
}

    resources:
  example:
    type: meraki:devices:ManagementInterface
    properties:
      serial: string
      wan1:
        static_dns:
          - 1.2.3.2
          - 1.2.3.3
        static_gateway_ip: 1.2.3.1
        static_ip: 1.2.3.4
        static_subnet_mask: 255.255.255.0
        using_static_ip: true
        vlan: 7
        wan_enabled: not configured
      wan2:
        static_dns:
          - 1.2.3.2
          - 1.2.3.3
        static_gateway_ip: 1.2.3.1
        static_ip: 1.2.3.4
        static_subnet_mask: 255.255.255.0
        using_static_ip: false
        vlan: 2
        wan_enabled: enabled
outputs:
  merakiDevicesManagementInterfaceExample: ${example}

    Create ManagementInterface Resource

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

    Constructor syntax

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

@overload
def ManagementInterface(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        serial: Optional[str] = None,
                        wan1: Optional[ManagementInterfaceWan1Args] = None,
                        wan2: Optional[ManagementInterfaceWan2Args] = None)
    func NewManagementInterface(ctx *Context, name string, args ManagementInterfaceArgs, opts ...ResourceOption) (*ManagementInterface, error)
    public ManagementInterface(string name, ManagementInterfaceArgs args, CustomResourceOptions? opts = null)
    public ManagementInterface(String name, ManagementInterfaceArgs args)
public ManagementInterface(String name, ManagementInterfaceArgs args, CustomResourceOptions options)

    type: meraki:devices:ManagementInterface
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 ManagementInterfaceArgs
    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 ManagementInterfaceArgs
    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 ManagementInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementInterfaceArgs
    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 managementInterfaceResource = new Meraki.Devices.ManagementInterface("managementInterfaceResource", new()
{
    Serial = "string",
    Wan1 = new Meraki.Devices.Inputs.ManagementInterfaceWan1Args
    {
        StaticDns = new[]
        {
            "string",
        },
        StaticGatewayIp = "string",
        StaticIp = "string",
        StaticSubnetMask = "string",
        UsingStaticIp = false,
        Vlan = 0,
        WanEnabled = "string",
    },
    Wan2 = new Meraki.Devices.Inputs.ManagementInterfaceWan2Args
    {
        StaticDns = new[]
        {
            "string",
        },
        StaticGatewayIp = "string",
        StaticIp = "string",
        StaticSubnetMask = "string",
        UsingStaticIp = false,
        Vlan = 0,
        WanEnabled = "string",
    },
});

    example, err := devices.NewManagementInterface(ctx, "managementInterfaceResource", &devices.ManagementInterfaceArgs{
	Serial: pulumi.String("string"),
	Wan1: &devices.ManagementInterfaceWan1Args{
		StaticDns: pulumi.StringArray{
			pulumi.String("string"),
		},
		StaticGatewayIp:  pulumi.String("string"),
		StaticIp:         pulumi.String("string"),
		StaticSubnetMask: pulumi.String("string"),
		UsingStaticIp:    pulumi.Bool(false),
		Vlan:             pulumi.Int(0),
		WanEnabled:       pulumi.String("string"),
	},
	Wan2: &devices.ManagementInterfaceWan2Args{
		StaticDns: pulumi.StringArray{
			pulumi.String("string"),
		},
		StaticGatewayIp:  pulumi.String("string"),
		StaticIp:         pulumi.String("string"),
		StaticSubnetMask: pulumi.String("string"),
		UsingStaticIp:    pulumi.Bool(false),
		Vlan:             pulumi.Int(0),
		WanEnabled:       pulumi.String("string"),
	},
})

    var managementInterfaceResource = new ManagementInterface("managementInterfaceResource", ManagementInterfaceArgs.builder()
    .serial("string")
    .wan1(ManagementInterfaceWan1Args.builder()
        .staticDns("string")
        .staticGatewayIp("string")
        .staticIp("string")
        .staticSubnetMask("string")
        .usingStaticIp(false)
        .vlan(0)
        .wanEnabled("string")
        .build())
    .wan2(ManagementInterfaceWan2Args.builder()
        .staticDns("string")
        .staticGatewayIp("string")
        .staticIp("string")
        .staticSubnetMask("string")
        .usingStaticIp(false)
        .vlan(0)
        .wanEnabled("string")
        .build())
    .build());

    management_interface_resource = meraki.devices.ManagementInterface("managementInterfaceResource",
    serial="string",
    wan1={
        "static_dns": ["string"],
        "static_gateway_ip": "string",
        "static_ip": "string",
        "static_subnet_mask": "string",
        "using_static_ip": False,
        "vlan": 0,
        "wan_enabled": "string",
    },
    wan2={
        "static_dns": ["string"],
        "static_gateway_ip": "string",
        "static_ip": "string",
        "static_subnet_mask": "string",
        "using_static_ip": False,
        "vlan": 0,
        "wan_enabled": "string",
    })

    const managementInterfaceResource = new meraki.devices.ManagementInterface("managementInterfaceResource", {
    serial: "string",
    wan1: {
        staticDns: ["string"],
        staticGatewayIp: "string",
        staticIp: "string",
        staticSubnetMask: "string",
        usingStaticIp: false,
        vlan: 0,
        wanEnabled: "string",
    },
    wan2: {
        staticDns: ["string"],
        staticGatewayIp: "string",
        staticIp: "string",
        staticSubnetMask: "string",
        usingStaticIp: false,
        vlan: 0,
        wanEnabled: "string",
    },
});

    type: meraki:devices:ManagementInterface
properties:
    serial: string
    wan1:
        staticDns:
            - string
        staticGatewayIp: string
        staticIp: string
        staticSubnetMask: string
        usingStaticIp: false
        vlan: 0
        wanEnabled: string
    wan2:
        staticDns:
            - string
        staticGatewayIp: string
        staticIp: string
        staticSubnetMask: string
        usingStaticIp: false
        vlan: 0
        wanEnabled: string

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

    Serial string
    serial path parameter.
    Wan1 ManagementInterfaceWan1
    WAN 1 settings
    Wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    Serial string
    serial path parameter.
    Wan1 ManagementInterfaceWan1Args
    WAN 1 settings
    Wan2 ManagementInterfaceWan2Args
    WAN 2 settings (only for MX devices)
    serial String
    serial path parameter.
    wan1 ManagementInterfaceWan1
    WAN 1 settings
    wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    serial string
    serial path parameter.
    wan1 ManagementInterfaceWan1
    WAN 1 settings
    wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    serial str
    serial path parameter.
    wan1 ManagementInterfaceWan1Args
    WAN 1 settings
    wan2 ManagementInterfaceWan2Args
    WAN 2 settings (only for MX devices)
    serial String
    serial path parameter.
    wan1 Property Map
    WAN 1 settings
    wan2 Property Map
    WAN 2 settings (only for MX devices)

    Outputs

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

    DdnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    Id string
    The provider-assigned unique ID for this managed resource.
    DdnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    Id string
    The provider-assigned unique ID for this managed resource.
    ddnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    id String
    The provider-assigned unique ID for this managed resource.
    ddnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    id string
    The provider-assigned unique ID for this managed resource.
    ddns_hostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    id str
    The provider-assigned unique ID for this managed resource.
    ddnsHostnames Property Map
    Dynamic DNS hostnames.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ManagementInterface Resource

    Get an existing ManagementInterface 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?: ManagementInterfaceState, opts?: CustomResourceOptions): ManagementInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ddns_hostnames: Optional[ManagementInterfaceDdnsHostnamesArgs] = None,
        serial: Optional[str] = None,
        wan1: Optional[ManagementInterfaceWan1Args] = None,
        wan2: Optional[ManagementInterfaceWan2Args] = None) -> ManagementInterface
    func GetManagementInterface(ctx *Context, name string, id IDInput, state *ManagementInterfaceState, opts ...ResourceOption) (*ManagementInterface, error)
    public static ManagementInterface Get(string name, Input<string> id, ManagementInterfaceState? state, CustomResourceOptions? opts = null)
    public static ManagementInterface get(String name, Output<String> id, ManagementInterfaceState 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:
    DdnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    Serial string
    serial path parameter.
    Wan1 ManagementInterfaceWan1
    WAN 1 settings
    Wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    DdnsHostnames ManagementInterfaceDdnsHostnamesArgs
    Dynamic DNS hostnames.
    Serial string
    serial path parameter.
    Wan1 ManagementInterfaceWan1Args
    WAN 1 settings
    Wan2 ManagementInterfaceWan2Args
    WAN 2 settings (only for MX devices)
    ddnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    serial String
    serial path parameter.
    wan1 ManagementInterfaceWan1
    WAN 1 settings
    wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    ddnsHostnames ManagementInterfaceDdnsHostnames
    Dynamic DNS hostnames.
    serial string
    serial path parameter.
    wan1 ManagementInterfaceWan1
    WAN 1 settings
    wan2 ManagementInterfaceWan2
    WAN 2 settings (only for MX devices)
    ddns_hostnames ManagementInterfaceDdnsHostnamesArgs
    Dynamic DNS hostnames.
    serial str
    serial path parameter.
    wan1 ManagementInterfaceWan1Args
    WAN 1 settings
    wan2 ManagementInterfaceWan2Args
    WAN 2 settings (only for MX devices)
    ddnsHostnames Property Map
    Dynamic DNS hostnames.
    serial String
    serial path parameter.
    wan1 Property Map
    WAN 1 settings
    wan2 Property Map
    WAN 2 settings (only for MX devices)

    Supporting Types

    ManagementInterfaceDdnsHostnames, ManagementInterfaceDdnsHostnamesArgs

    ActiveDdnsHostname string
    Active dynamic DNS hostname.
    DdnsHostnameWan1 string
    WAN 1 dynamic DNS hostname.
    DdnsHostnameWan2 string
    WAN 2 dynamic DNS hostname.
    ActiveDdnsHostname string
    Active dynamic DNS hostname.
    DdnsHostnameWan1 string
    WAN 1 dynamic DNS hostname.
    DdnsHostnameWan2 string
    WAN 2 dynamic DNS hostname.
    activeDdnsHostname String
    Active dynamic DNS hostname.
    ddnsHostnameWan1 String
    WAN 1 dynamic DNS hostname.
    ddnsHostnameWan2 String
    WAN 2 dynamic DNS hostname.
    activeDdnsHostname string
    Active dynamic DNS hostname.
    ddnsHostnameWan1 string
    WAN 1 dynamic DNS hostname.
    ddnsHostnameWan2 string
    WAN 2 dynamic DNS hostname.
    active_ddns_hostname str
    Active dynamic DNS hostname.
    ddns_hostname_wan1 str
    WAN 1 dynamic DNS hostname.
    ddns_hostname_wan2 str
    WAN 2 dynamic DNS hostname.
    activeDdnsHostname String
    Active dynamic DNS hostname.
    ddnsHostnameWan1 String
    WAN 1 dynamic DNS hostname.
    ddnsHostnameWan2 String
    WAN 2 dynamic DNS hostname.

    ManagementInterfaceWan1, ManagementInterfaceWan1Args

    StaticDns List<string>
    Up to two DNS IPs.
    StaticGatewayIp string
    The IP of the gateway on the WAN.
    StaticIp string
    The IP the device should use on the WAN.
    StaticSubnetMask string
    The subnet mask for the WAN.
    UsingStaticIp bool
    Configure the interface to have static IP settings or use DHCP.
    Vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    WanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    StaticDns []string
    Up to two DNS IPs.
    StaticGatewayIp string
    The IP of the gateway on the WAN.
    StaticIp string
    The IP the device should use on the WAN.
    StaticSubnetMask string
    The subnet mask for the WAN.
    UsingStaticIp bool
    Configure the interface to have static IP settings or use DHCP.
    Vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    WanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns List<String>
    Up to two DNS IPs.
    staticGatewayIp String
    The IP of the gateway on the WAN.
    staticIp String
    The IP the device should use on the WAN.
    staticSubnetMask String
    The subnet mask for the WAN.
    usingStaticIp Boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan Integer
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled String
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns string[]
    Up to two DNS IPs.
    staticGatewayIp string
    The IP of the gateway on the WAN.
    staticIp string
    The IP the device should use on the WAN.
    staticSubnetMask string
    The subnet mask for the WAN.
    usingStaticIp boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan number
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    static_dns Sequence[str]
    Up to two DNS IPs.
    static_gateway_ip str
    The IP of the gateway on the WAN.
    static_ip str
    The IP the device should use on the WAN.
    static_subnet_mask str
    The subnet mask for the WAN.
    using_static_ip bool
    Configure the interface to have static IP settings or use DHCP.
    vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wan_enabled str
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns List<String>
    Up to two DNS IPs.
    staticGatewayIp String
    The IP of the gateway on the WAN.
    staticIp String
    The IP the device should use on the WAN.
    staticSubnetMask String
    The subnet mask for the WAN.
    usingStaticIp Boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan Number
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled String
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.

    ManagementInterfaceWan2, ManagementInterfaceWan2Args

    StaticDns List<string>
    Up to two DNS IPs.
    StaticGatewayIp string
    The IP of the gateway on the WAN.
    StaticIp string
    The IP the device should use on the WAN.
    StaticSubnetMask string
    The subnet mask for the WAN.
    UsingStaticIp bool
    Configure the interface to have static IP settings or use DHCP.
    Vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    WanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    StaticDns []string
    Up to two DNS IPs.
    StaticGatewayIp string
    The IP of the gateway on the WAN.
    StaticIp string
    The IP the device should use on the WAN.
    StaticSubnetMask string
    The subnet mask for the WAN.
    UsingStaticIp bool
    Configure the interface to have static IP settings or use DHCP.
    Vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    WanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns List<String>
    Up to two DNS IPs.
    staticGatewayIp String
    The IP of the gateway on the WAN.
    staticIp String
    The IP the device should use on the WAN.
    staticSubnetMask String
    The subnet mask for the WAN.
    usingStaticIp Boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan Integer
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled String
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns string[]
    Up to two DNS IPs.
    staticGatewayIp string
    The IP of the gateway on the WAN.
    staticIp string
    The IP the device should use on the WAN.
    staticSubnetMask string
    The subnet mask for the WAN.
    usingStaticIp boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan number
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled string
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    static_dns Sequence[str]
    Up to two DNS IPs.
    static_gateway_ip str
    The IP of the gateway on the WAN.
    static_ip str
    The IP the device should use on the WAN.
    static_subnet_mask str
    The subnet mask for the WAN.
    using_static_ip bool
    Configure the interface to have static IP settings or use DHCP.
    vlan int
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wan_enabled str
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
    staticDns List<String>
    Up to two DNS IPs.
    staticGatewayIp String
    The IP of the gateway on the WAN.
    staticIp String
    The IP the device should use on the WAN.
    staticSubnetMask String
    The subnet mask for the WAN.
    usingStaticIp Boolean
    Configure the interface to have static IP settings or use DHCP.
    vlan Number
    The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    wanEnabled String
    Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.

    Import

    $ pulumi import meraki:devices/managementInterface:ManagementInterface example "serial"

    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.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-meraki