1. Packages
  2. Meraki Provider
  3. API Docs
  4. networks
  5. SwitchAlternateManagementInterface
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.networks.SwitchAlternateManagementInterface

Explore with Pulumi AI

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

    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.networks.SwitchAlternateManagementInterface;
    import com.pulumi.meraki.networks.SwitchAlternateManagementInterfaceArgs;
    import com.pulumi.meraki.networks.inputs.SwitchAlternateManagementInterfaceSwitchArgs;
    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 SwitchAlternateManagementInterface("example", SwitchAlternateManagementInterfaceArgs.builder()
                .enabled(true)
                .networkId("string")
                .protocols(            
                    "radius",
                    "snmp",
                    "syslog")
                .switches(SwitchAlternateManagementInterfaceSwitchArgs.builder()
                    .alternate_management_ip("1.2.3.4")
                    .gateway("1.2.3.5")
                    .serial("Q234-ABCD-5678")
                    .subnet_mask("255.255.255.0")
                    .build())
                .vlanId(100)
                .build());
    
            ctx.export("merakiNetworksSwitchAlternateManagementInterfaceExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:SwitchAlternateManagementInterface
        properties:
          enabled: true
          networkId: string
          protocols:
            - radius
            - snmp
            - syslog
          switches:
            - alternate_management_ip: 1.2.3.4
              gateway: 1.2.3.5
              serial: Q234-ABCD-5678
              subnet_mask: 255.255.255.0
          vlanId: 100
    outputs:
      merakiNetworksSwitchAlternateManagementInterfaceExample: ${example}
    

    Create SwitchAlternateManagementInterface Resource

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

    Constructor syntax

    new SwitchAlternateManagementInterface(name: string, args: SwitchAlternateManagementInterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def SwitchAlternateManagementInterface(resource_name: str,
                                           args: SwitchAlternateManagementInterfaceArgs,
                                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def SwitchAlternateManagementInterface(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           network_id: Optional[str] = None,
                                           enabled: Optional[bool] = None,
                                           protocols: Optional[Sequence[str]] = None,
                                           switches: Optional[Sequence[SwitchAlternateManagementInterfaceSwitchArgs]] = None,
                                           vlan_id: Optional[int] = None)
    func NewSwitchAlternateManagementInterface(ctx *Context, name string, args SwitchAlternateManagementInterfaceArgs, opts ...ResourceOption) (*SwitchAlternateManagementInterface, error)
    public SwitchAlternateManagementInterface(string name, SwitchAlternateManagementInterfaceArgs args, CustomResourceOptions? opts = null)
    public SwitchAlternateManagementInterface(String name, SwitchAlternateManagementInterfaceArgs args)
    public SwitchAlternateManagementInterface(String name, SwitchAlternateManagementInterfaceArgs args, CustomResourceOptions options)
    
    type: meraki:networks:SwitchAlternateManagementInterface
    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 SwitchAlternateManagementInterfaceArgs
    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 SwitchAlternateManagementInterfaceArgs
    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 SwitchAlternateManagementInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchAlternateManagementInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchAlternateManagementInterfaceArgs
    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 switchAlternateManagementInterfaceResource = new Meraki.Networks.SwitchAlternateManagementInterface("switchAlternateManagementInterfaceResource", new()
    {
        NetworkId = "string",
        Enabled = false,
        Protocols = new[]
        {
            "string",
        },
        Switches = new[]
        {
            new Meraki.Networks.Inputs.SwitchAlternateManagementInterfaceSwitchArgs
            {
                AlternateManagementIp = "string",
                Gateway = "string",
                Serial = "string",
                SubnetMask = "string",
            },
        },
        VlanId = 0,
    });
    
    example, err := networks.NewSwitchAlternateManagementInterface(ctx, "switchAlternateManagementInterfaceResource", &networks.SwitchAlternateManagementInterfaceArgs{
    	NetworkId: pulumi.String("string"),
    	Enabled:   pulumi.Bool(false),
    	Protocols: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Switches: networks.SwitchAlternateManagementInterfaceSwitchArray{
    		&networks.SwitchAlternateManagementInterfaceSwitchArgs{
    			AlternateManagementIp: pulumi.String("string"),
    			Gateway:               pulumi.String("string"),
    			Serial:                pulumi.String("string"),
    			SubnetMask:            pulumi.String("string"),
    		},
    	},
    	VlanId: pulumi.Int(0),
    })
    
    var switchAlternateManagementInterfaceResource = new SwitchAlternateManagementInterface("switchAlternateManagementInterfaceResource", SwitchAlternateManagementInterfaceArgs.builder()
        .networkId("string")
        .enabled(false)
        .protocols("string")
        .switches(SwitchAlternateManagementInterfaceSwitchArgs.builder()
            .alternateManagementIp("string")
            .gateway("string")
            .serial("string")
            .subnetMask("string")
            .build())
        .vlanId(0)
        .build());
    
    switch_alternate_management_interface_resource = meraki.networks.SwitchAlternateManagementInterface("switchAlternateManagementInterfaceResource",
        network_id="string",
        enabled=False,
        protocols=["string"],
        switches=[{
            "alternate_management_ip": "string",
            "gateway": "string",
            "serial": "string",
            "subnet_mask": "string",
        }],
        vlan_id=0)
    
    const switchAlternateManagementInterfaceResource = new meraki.networks.SwitchAlternateManagementInterface("switchAlternateManagementInterfaceResource", {
        networkId: "string",
        enabled: false,
        protocols: ["string"],
        switches: [{
            alternateManagementIp: "string",
            gateway: "string",
            serial: "string",
            subnetMask: "string",
        }],
        vlanId: 0,
    });
    
    type: meraki:networks:SwitchAlternateManagementInterface
    properties:
        enabled: false
        networkId: string
        protocols:
            - string
        switches:
            - alternateManagementIp: string
              gateway: string
              serial: string
              subnetMask: string
        vlanId: 0
    

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

    NetworkId string
    networkId path parameter. Network ID
    Enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    Protocols List<string>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    Switches List<SwitchAlternateManagementInterfaceSwitch>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    VlanId int
    Alternate management VLAN, must be between 1 and 4094
    NetworkId string
    networkId path parameter. Network ID
    Enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    Protocols []string
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    Switches []SwitchAlternateManagementInterfaceSwitchArgs
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    VlanId int
    Alternate management VLAN, must be between 1 and 4094
    networkId String
    networkId path parameter. Network ID
    enabled Boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    protocols List<String>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches List<SwitchAlternateManagementInterfaceSwitch>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId Integer
    Alternate management VLAN, must be between 1 and 4094
    networkId string
    networkId path parameter. Network ID
    enabled boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    protocols string[]
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches SwitchAlternateManagementInterfaceSwitch[]
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId number
    Alternate management VLAN, must be between 1 and 4094
    network_id str
    networkId path parameter. Network ID
    enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    protocols Sequence[str]
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches Sequence[SwitchAlternateManagementInterfaceSwitchArgs]
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlan_id int
    Alternate management VLAN, must be between 1 and 4094
    networkId String
    networkId path parameter. Network ID
    enabled Boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    protocols List<String>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches List<Property Map>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId Number
    Alternate management VLAN, must be between 1 and 4094

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SwitchAlternateManagementInterface 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 SwitchAlternateManagementInterface Resource

    Get an existing SwitchAlternateManagementInterface 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?: SwitchAlternateManagementInterfaceState, opts?: CustomResourceOptions): SwitchAlternateManagementInterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            network_id: Optional[str] = None,
            protocols: Optional[Sequence[str]] = None,
            switches: Optional[Sequence[SwitchAlternateManagementInterfaceSwitchArgs]] = None,
            vlan_id: Optional[int] = None) -> SwitchAlternateManagementInterface
    func GetSwitchAlternateManagementInterface(ctx *Context, name string, id IDInput, state *SwitchAlternateManagementInterfaceState, opts ...ResourceOption) (*SwitchAlternateManagementInterface, error)
    public static SwitchAlternateManagementInterface Get(string name, Input<string> id, SwitchAlternateManagementInterfaceState? state, CustomResourceOptions? opts = null)
    public static SwitchAlternateManagementInterface get(String name, Output<String> id, SwitchAlternateManagementInterfaceState 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:
    Enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    NetworkId string
    networkId path parameter. Network ID
    Protocols List<string>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    Switches List<SwitchAlternateManagementInterfaceSwitch>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    VlanId int
    Alternate management VLAN, must be between 1 and 4094
    Enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    NetworkId string
    networkId path parameter. Network ID
    Protocols []string
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    Switches []SwitchAlternateManagementInterfaceSwitchArgs
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    VlanId int
    Alternate management VLAN, must be between 1 and 4094
    enabled Boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    networkId String
    networkId path parameter. Network ID
    protocols List<String>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches List<SwitchAlternateManagementInterfaceSwitch>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId Integer
    Alternate management VLAN, must be between 1 and 4094
    enabled boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    networkId string
    networkId path parameter. Network ID
    protocols string[]
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches SwitchAlternateManagementInterfaceSwitch[]
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId number
    Alternate management VLAN, must be between 1 and 4094
    enabled bool
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    network_id str
    networkId path parameter. Network ID
    protocols Sequence[str]
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches Sequence[SwitchAlternateManagementInterfaceSwitchArgs]
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlan_id int
    Alternate management VLAN, must be between 1 and 4094
    enabled Boolean
    Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
    networkId String
    networkId path parameter. Network ID
    protocols List<String>
    Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
    switches List<Property Map>
    Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments
    vlanId Number
    Alternate management VLAN, must be between 1 and 4094

    Supporting Types

    SwitchAlternateManagementInterfaceSwitch, SwitchAlternateManagementInterfaceSwitchArgs

    AlternateManagementIp string
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    Gateway string
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    Serial string
    Switch serial number
    SubnetMask string
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches
    AlternateManagementIp string
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    Gateway string
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    Serial string
    Switch serial number
    SubnetMask string
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches
    alternateManagementIp String
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    gateway String
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    serial String
    Switch serial number
    subnetMask String
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches
    alternateManagementIp string
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    gateway string
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    serial string
    Switch serial number
    subnetMask string
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches
    alternate_management_ip str
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    gateway str
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    serial str
    Switch serial number
    subnet_mask str
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches
    alternateManagementIp String
    Switch alternative management IP. To remove a prior IP setting, provide an empty string
    gateway String
    Switch gateway must be in IP format. Only and must be specified for Polaris switches
    serial String
    Switch serial number
    subnetMask String
    Switch subnet mask must be in IP format. Only and must be specified for Polaris switches

    Import

    $ pulumi import meraki:networks/switchAlternateManagementInterface:SwitchAlternateManagementInterface example "network_id"
    

    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