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

meraki.devices.Base

Explore with Pulumi AI

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

    Example Usage

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

const example = new meraki.devices.Base("example", {
    lat: 37.4180951010362,
    lng: -122.098531723022,
    name: "My AP",
    serial: "string",
    tags: ["recently-added"],
});
export const merakiDevicesExample = example;

    import pulumi
import pulumi_meraki as meraki

example = meraki.devices.Base("example",
    lat=37.4180951010362,
    lng=-122.098531723022,
    name="My AP",
    serial="string",
    tags=["recently-added"])
pulumi.export("merakiDevicesExample", example)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := devices.Newbase(ctx, "example", &devices.baseArgs{
			Lat:    pulumi.Float64(37.4180951010362),
			Lng:    -122.098531723022,
			Name:   pulumi.String("My AP"),
			Serial: pulumi.String("string"),
			Tags: pulumi.StringArray{
				pulumi.String("recently-added"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiDevicesExample", example)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Devices.Base("example", new()
    {
        Lat = 37.4180951010362,
        Lng = -122.098531723022,
        Name = "My AP",
        Serial = "string",
        Tags = new[]
        {
            "recently-added",
        },
    });

    return new Dictionary<string, object?>
    {
        ["merakiDevicesExample"] = example,
    };
});

    Coming soon!

    resources:
  example:
    type: meraki:devices:base
    properties:
      lat: 37.4180951010362
      lng: -122.098531723022
      name: My AP
      serial: string
      tags:
        - recently-added
outputs:
  merakiDevicesExample: ${example}

    Create Base Resource

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

    Constructor syntax

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

@overload
def Base(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         serial: Optional[str] = None,
         address: Optional[str] = None,
         floor_plan_id: Optional[str] = None,
         lat: Optional[float] = None,
         lng: Optional[float] = None,
         move_map_marker: Optional[bool] = None,
         name: Optional[str] = None,
         notes: Optional[str] = None,
         switch_profile_id: Optional[str] = None,
         tags: Optional[Sequence[str]] = None)
    func NewBase(ctx *Context, name string, args BaseArgs, opts ...ResourceOption) (*Base, error)
    public Base(string name, BaseArgs args, CustomResourceOptions? opts = null)
    public Base(String name, BaseArgs args)
public Base(String name, BaseArgs args, CustomResourceOptions options)

    type: meraki:devices/base:base
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 BaseArgs
    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 BaseArgs
    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 BaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Serial string
    Serial number of the device
    Address string
    Physical address of the device
    FloorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    Lat double
    Latitude of the device
    Lng double
    Longitude of the device
    MoveMapMarker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    Name string
    Name of the device
    Notes string
    Notes for the device, limited to 255 characters
    SwitchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    Tags List<string>
    List of tags assigned to the device
    Serial string
    Serial number of the device
    Address string
    Physical address of the device
    FloorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    Lat float64
    Latitude of the device
    Lng float64
    Longitude of the device
    MoveMapMarker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    Name string
    Name of the device
    Notes string
    Notes for the device, limited to 255 characters
    SwitchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    Tags []string
    List of tags assigned to the device
    serial String
    Serial number of the device
    address String
    Physical address of the device
    floorPlanId String
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    lat Double
    Latitude of the device
    lng Double
    Longitude of the device
    moveMapMarker Boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name String
    Name of the device
    notes String
    Notes for the device, limited to 255 characters
    switchProfileId String
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags List<String>
    List of tags assigned to the device
    serial string
    Serial number of the device
    address string
    Physical address of the device
    floorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    lat number
    Latitude of the device
    lng number
    Longitude of the device
    moveMapMarker boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name string
    Name of the device
    notes string
    Notes for the device, limited to 255 characters
    switchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags string[]
    List of tags assigned to the device
    serial str
    Serial number of the device
    address str
    Physical address of the device
    floor_plan_id str
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    lat float
    Latitude of the device
    lng float
    Longitude of the device
    move_map_marker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name str
    Name of the device
    notes str
    Notes for the device, limited to 255 characters
    switch_profile_id str
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags Sequence[str]
    List of tags assigned to the device
    serial String
    Serial number of the device
    address String
    Physical address of the device
    floorPlanId String
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    lat Number
    Latitude of the device
    lng Number
    Longitude of the device
    moveMapMarker Boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name String
    Name of the device
    notes String
    Notes for the device, limited to 255 characters
    switchProfileId String
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags List<String>
    List of tags assigned to the device

    Outputs

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

    Details List<BaseDetail>
    Additional device information
    Firmware string
    Firmware version of the device
    Id string
    The provider-assigned unique ID for this managed resource.
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    NetworkId string
    ID of the network the device belongs to
    ProductType string
    Product type of the device
    Details []BaseDetail
    Additional device information
    Firmware string
    Firmware version of the device
    Id string
    The provider-assigned unique ID for this managed resource.
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    NetworkId string
    ID of the network the device belongs to
    ProductType string
    Product type of the device
    details List<BaseDetail>
    Additional device information
    firmware String
    Firmware version of the device
    id String
    The provider-assigned unique ID for this managed resource.
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    networkId String
    ID of the network the device belongs to
    productType String
    Product type of the device
    details BaseDetail[]
    Additional device information
    firmware string
    Firmware version of the device
    id string
    The provider-assigned unique ID for this managed resource.
    imei string
    IMEI of the device, if applicable
    lanIp string
    LAN IP address of the device
    mac string
    MAC address of the device
    model string
    Model of the device
    networkId string
    ID of the network the device belongs to
    productType string
    Product type of the device
    details Sequence[BaseDetail]
    Additional device information
    firmware str
    Firmware version of the device
    id str
    The provider-assigned unique ID for this managed resource.
    imei str
    IMEI of the device, if applicable
    lan_ip str
    LAN IP address of the device
    mac str
    MAC address of the device
    model str
    Model of the device
    network_id str
    ID of the network the device belongs to
    product_type str
    Product type of the device
    details List<Property Map>
    Additional device information
    firmware String
    Firmware version of the device
    id String
    The provider-assigned unique ID for this managed resource.
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    networkId String
    ID of the network the device belongs to
    productType String
    Product type of the device

    Look up Existing Base Resource

    Get an existing Base 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?: BaseState, opts?: CustomResourceOptions): Base
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        details: Optional[Sequence[BaseDetailArgs]] = None,
        firmware: Optional[str] = None,
        floor_plan_id: Optional[str] = None,
        imei: Optional[str] = None,
        lan_ip: Optional[str] = None,
        lat: Optional[float] = None,
        lng: Optional[float] = None,
        mac: Optional[str] = None,
        model: Optional[str] = None,
        move_map_marker: Optional[bool] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        notes: Optional[str] = None,
        product_type: Optional[str] = None,
        serial: Optional[str] = None,
        switch_profile_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> Base
    func GetBase(ctx *Context, name string, id IDInput, state *BaseState, opts ...ResourceOption) (*Base, error)
    public static Base Get(string name, Input<string> id, BaseState? state, CustomResourceOptions? opts = null)
    public static Base get(String name, Output<String> id, BaseState 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:
    Address string
    Physical address of the device
    Details List<BaseDetailArgs>
    Additional device information
    Firmware string
    Firmware version of the device
    FloorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat double
    Latitude of the device
    Lng double
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    MoveMapMarker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    SwitchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    Tags List<string>
    List of tags assigned to the device
    Address string
    Physical address of the device
    Details []BaseDetailArgs
    Additional device information
    Firmware string
    Firmware version of the device
    FloorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    Imei string
    IMEI of the device, if applicable
    LanIp string
    LAN IP address of the device
    Lat float64
    Latitude of the device
    Lng float64
    Longitude of the device
    Mac string
    MAC address of the device
    Model string
    Model of the device
    MoveMapMarker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    Name string
    Name of the device
    NetworkId string
    ID of the network the device belongs to
    Notes string
    Notes for the device, limited to 255 characters
    ProductType string
    Product type of the device
    Serial string
    Serial number of the device
    SwitchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    Tags []string
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<BaseDetailArgs>
    Additional device information
    firmware String
    Firmware version of the device
    floorPlanId String
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Double
    Latitude of the device
    lng Double
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    moveMapMarker Boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    switchProfileId String
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags List<String>
    List of tags assigned to the device
    address string
    Physical address of the device
    details BaseDetailArgs[]
    Additional device information
    firmware string
    Firmware version of the device
    floorPlanId string
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    imei string
    IMEI of the device, if applicable
    lanIp string
    LAN IP address of the device
    lat number
    Latitude of the device
    lng number
    Longitude of the device
    mac string
    MAC address of the device
    model string
    Model of the device
    moveMapMarker boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name string
    Name of the device
    networkId string
    ID of the network the device belongs to
    notes string
    Notes for the device, limited to 255 characters
    productType string
    Product type of the device
    serial string
    Serial number of the device
    switchProfileId string
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags string[]
    List of tags assigned to the device
    address str
    Physical address of the device
    details Sequence[BaseDetailArgs]
    Additional device information
    firmware str
    Firmware version of the device
    floor_plan_id str
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    imei str
    IMEI of the device, if applicable
    lan_ip str
    LAN IP address of the device
    lat float
    Latitude of the device
    lng float
    Longitude of the device
    mac str
    MAC address of the device
    model str
    Model of the device
    move_map_marker bool
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name str
    Name of the device
    network_id str
    ID of the network the device belongs to
    notes str
    Notes for the device, limited to 255 characters
    product_type str
    Product type of the device
    serial str
    Serial number of the device
    switch_profile_id str
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags Sequence[str]
    List of tags assigned to the device
    address String
    Physical address of the device
    details List<Property Map>
    Additional device information
    firmware String
    Firmware version of the device
    floorPlanId String
    The floor plan to associate to this device. null disassociates the device from the floorplan.
    imei String
    IMEI of the device, if applicable
    lanIp String
    LAN IP address of the device
    lat Number
    Latitude of the device
    lng Number
    Longitude of the device
    mac String
    MAC address of the device
    model String
    Model of the device
    moveMapMarker Boolean
    Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
    name String
    Name of the device
    networkId String
    ID of the network the device belongs to
    notes String
    Notes for the device, limited to 255 characters
    productType String
    Product type of the device
    serial String
    Serial number of the device
    switchProfileId String
    The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
    tags List<String>
    List of tags assigned to the device

    Supporting Types

    BaseDetail, BaseDetailArgs

    Name string
    Additional property name
    Value string
    Additional property value
    Name string
    Additional property name
    Value string
    Additional property value
    name String
    Additional property name
    value String
    Additional property value
    name string
    Additional property name
    value string
    Additional property value
    name str
    Additional property name
    value str
    Additional property value
    name String
    Additional property name
    value String
    Additional property value

    Import

    $ pulumi import meraki:devices/base:base example "organization_id,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