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

meraki.networks.SmDevicesLock

Explore with Pulumi AI

~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

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.SmDevicesLock;
import com.pulumi.meraki.networks.SmDevicesLockArgs;
import com.pulumi.meraki.networks.inputs.SmDevicesLockParametersArgs;
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 SmDevicesLock("example", SmDevicesLockArgs.builder()
            .networkId("string")
            .parameters(SmDevicesLockParametersArgs.builder()
                .ids(                
                    "1284392014819",
                    "2983092129865")
                .pin(123456)
                .scope(                
                    "withAny",
                    "tag1",
                    "tag2")
                .serials(                
                    "XY0XX0Y0X0",
                    "A01B01CD00E",
                    "X02YZ1ZYZX")
                .wifi_macs("00:11:22:33:44:55")
                .build())
            .build());

        ctx.export("merakiNetworksSmDevicesLockExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:networks:SmDevicesLock
    properties:
      networkId: string
      parameters:
        ids:
          - '1284392014819'
          - '2983092129865'
        pin: 123456
        scope:
          - withAny
          - tag1
          - tag2
        serials:
          - XY0XX0Y0X0
          - A01B01CD00E
          - X02YZ1ZYZX
        wifi_macs:
          - 00:11:22:33:44:55
outputs:
  merakiNetworksSmDevicesLockExample: ${example}
Copy

Create SmDevicesLock Resource

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

Constructor syntax

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

@overload
def SmDevicesLock(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  network_id: Optional[str] = None,
                  parameters: Optional[SmDevicesLockParametersArgs] = None)
func NewSmDevicesLock(ctx *Context, name string, args SmDevicesLockArgs, opts ...ResourceOption) (*SmDevicesLock, error)
public SmDevicesLock(string name, SmDevicesLockArgs args, CustomResourceOptions? opts = null)
public SmDevicesLock(String name, SmDevicesLockArgs args)
public SmDevicesLock(String name, SmDevicesLockArgs args, CustomResourceOptions options)
type: meraki:networks:SmDevicesLock
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. SmDevicesLockArgs
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. SmDevicesLockArgs
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. SmDevicesLockArgs
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. SmDevicesLockArgs
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. SmDevicesLockArgs
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 smDevicesLockResource = new Meraki.Networks.SmDevicesLock("smDevicesLockResource", new()
{
    NetworkId = "string",
    Parameters = new Meraki.Networks.Inputs.SmDevicesLockParametersArgs
    {
        Ids = new[]
        {
            "string",
        },
        Pin = 0,
        Scopes = new[]
        {
            "string",
        },
        Serials = new[]
        {
            "string",
        },
        WifiMacs = new[]
        {
            "string",
        },
    },
});
Copy
example, err := networks.NewSmDevicesLock(ctx, "smDevicesLockResource", &networks.SmDevicesLockArgs{
	NetworkId: pulumi.String("string"),
	Parameters: &networks.SmDevicesLockParametersArgs{
		Ids: pulumi.StringArray{
			pulumi.String("string"),
		},
		Pin: pulumi.Int(0),
		Scopes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Serials: pulumi.StringArray{
			pulumi.String("string"),
		},
		WifiMacs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})
Copy
var smDevicesLockResource = new SmDevicesLock("smDevicesLockResource", SmDevicesLockArgs.builder()
    .networkId("string")
    .parameters(SmDevicesLockParametersArgs.builder()
        .ids("string")
        .pin(0)
        .scopes("string")
        .serials("string")
        .wifiMacs("string")
        .build())
    .build());
Copy
sm_devices_lock_resource = meraki.networks.SmDevicesLock("smDevicesLockResource",
    network_id="string",
    parameters={
        "ids": ["string"],
        "pin": 0,
        "scopes": ["string"],
        "serials": ["string"],
        "wifi_macs": ["string"],
    })
Copy
const smDevicesLockResource = new meraki.networks.SmDevicesLock("smDevicesLockResource", {
    networkId: "string",
    parameters: {
        ids: ["string"],
        pin: 0,
        scopes: ["string"],
        serials: ["string"],
        wifiMacs: ["string"],
    },
});
Copy
type: meraki:networks:SmDevicesLock
properties:
    networkId: string
    parameters:
        ids:
            - string
        pin: 0
        scopes:
            - string
        serials:
            - string
        wifiMacs:
            - string
Copy

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

NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. SmDevicesLockParameters
NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. SmDevicesLockParametersArgs
networkId This property is required. String
networkId path parameter. Network ID
parameters This property is required. SmDevicesLockParameters
networkId This property is required. string
networkId path parameter. Network ID
parameters This property is required. SmDevicesLockParameters
network_id This property is required. str
networkId path parameter. Network ID
parameters This property is required. SmDevicesLockParametersArgs
networkId This property is required. String
networkId path parameter. Network ID
parameters This property is required. Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Item SmDevicesLockItem
Id string
The provider-assigned unique ID for this managed resource.
Item SmDevicesLockItem
id String
The provider-assigned unique ID for this managed resource.
item SmDevicesLockItem
id string
The provider-assigned unique ID for this managed resource.
item SmDevicesLockItem
id str
The provider-assigned unique ID for this managed resource.
item SmDevicesLockItem
id String
The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing SmDevicesLock Resource

Get an existing SmDevicesLock 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?: SmDevicesLockState, opts?: CustomResourceOptions): SmDevicesLock
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[SmDevicesLockItemArgs] = None,
        network_id: Optional[str] = None,
        parameters: Optional[SmDevicesLockParametersArgs] = None) -> SmDevicesLock
func GetSmDevicesLock(ctx *Context, name string, id IDInput, state *SmDevicesLockState, opts ...ResourceOption) (*SmDevicesLock, error)
public static SmDevicesLock Get(string name, Input<string> id, SmDevicesLockState? state, CustomResourceOptions? opts = null)
public static SmDevicesLock get(String name, Output<String> id, SmDevicesLockState state, CustomResourceOptions options)
resources:  _:    type: meraki:networks:SmDevicesLock    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:
Item SmDevicesLockItem
NetworkId string
networkId path parameter. Network ID
Parameters SmDevicesLockParameters
item SmDevicesLockItem
networkId String
networkId path parameter. Network ID
parameters SmDevicesLockParameters
item SmDevicesLockItem
networkId string
networkId path parameter. Network ID
parameters SmDevicesLockParameters
item Property Map
networkId String
networkId path parameter. Network ID
parameters Property Map

Supporting Types

SmDevicesLockItem
, SmDevicesLockItemArgs

Ids List<string>
The Meraki Ids of the set of devices.
Ids []string
The Meraki Ids of the set of devices.
ids List<String>
The Meraki Ids of the set of devices.
ids string[]
The Meraki Ids of the set of devices.
ids Sequence[str]
The Meraki Ids of the set of devices.
ids List<String>
The Meraki Ids of the set of devices.

SmDevicesLockParameters
, SmDevicesLockParametersArgs

Ids List<string>
The ids of the devices to be locked.
Pin int
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
Scopes List<string>
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
Serials List<string>
The serials of the devices to be locked.
WifiMacs List<string>
The wifiMacs of the devices to be locked.
Ids []string
The ids of the devices to be locked.
Pin int
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
Scopes []string
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
Serials []string
The serials of the devices to be locked.
WifiMacs []string
The wifiMacs of the devices to be locked.
ids List<String>
The ids of the devices to be locked.
pin Integer
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
scopes List<String>
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
serials List<String>
The serials of the devices to be locked.
wifiMacs List<String>
The wifiMacs of the devices to be locked.
ids string[]
The ids of the devices to be locked.
pin number
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
scopes string[]
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
serials string[]
The serials of the devices to be locked.
wifiMacs string[]
The wifiMacs of the devices to be locked.
ids Sequence[str]
The ids of the devices to be locked.
pin int
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
scopes Sequence[str]
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
serials Sequence[str]
The serials of the devices to be locked.
wifi_macs Sequence[str]
The wifiMacs of the devices to be locked.
ids List<String>
The ids of the devices to be locked.
pin Number
The pin number for locking macOS devices (a six digit number). Required only for macOS devices.
scopes List<String>
The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped.
serials List<String>
The serials of the devices to be locked.
wifiMacs List<String>
The wifiMacs of the devices to be locked.

Package Details

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