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

meraki.networks.SmDevicesWipe

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.SmDevicesWipe;
import com.pulumi.meraki.networks.SmDevicesWipeArgs;
import com.pulumi.meraki.networks.inputs.SmDevicesWipeParametersArgs;
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 SmDevicesWipe("example", SmDevicesWipeArgs.builder()
            .networkId("string")
            .parameters(SmDevicesWipeParametersArgs.builder()
                .id("1284392014819")
                .pin(123456)
                .serial("XY0XX0Y0X0")
                .wifi_mac("00:11:22:33:44:55")
                .build())
            .build());

        ctx.export("merakiNetworksSmDevicesWipeExample", example);
    }
}
Copy
resources:
  example:
    type: meraki:networks:SmDevicesWipe
    properties:
      networkId: string
      parameters:
        id: '1284392014819'
        pin: 123456
        serial: XY0XX0Y0X0
        wifi_mac: 00:11:22:33:44:55
outputs:
  merakiNetworksSmDevicesWipeExample: ${example}
Copy

Create SmDevicesWipe Resource

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

Constructor syntax

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

@overload
def SmDevicesWipe(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  network_id: Optional[str] = None,
                  parameters: Optional[SmDevicesWipeParametersArgs] = None)
func NewSmDevicesWipe(ctx *Context, name string, args SmDevicesWipeArgs, opts ...ResourceOption) (*SmDevicesWipe, error)
public SmDevicesWipe(string name, SmDevicesWipeArgs args, CustomResourceOptions? opts = null)
public SmDevicesWipe(String name, SmDevicesWipeArgs args)
public SmDevicesWipe(String name, SmDevicesWipeArgs args, CustomResourceOptions options)
type: meraki:networks:SmDevicesWipe
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. SmDevicesWipeArgs
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. SmDevicesWipeArgs
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. SmDevicesWipeArgs
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. SmDevicesWipeArgs
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. SmDevicesWipeArgs
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 smDevicesWipeResource = new Meraki.Networks.SmDevicesWipe("smDevicesWipeResource", new()
{
    NetworkId = "string",
    Parameters = new Meraki.Networks.Inputs.SmDevicesWipeParametersArgs
    {
        Id = "string",
        Pin = 0,
        Serial = "string",
        WifiMac = "string",
    },
});
Copy
example, err := networks.NewSmDevicesWipe(ctx, "smDevicesWipeResource", &networks.SmDevicesWipeArgs{
	NetworkId: pulumi.String("string"),
	Parameters: &networks.SmDevicesWipeParametersArgs{
		Id:      pulumi.String("string"),
		Pin:     pulumi.Int(0),
		Serial:  pulumi.String("string"),
		WifiMac: pulumi.String("string"),
	},
})
Copy
var smDevicesWipeResource = new SmDevicesWipe("smDevicesWipeResource", SmDevicesWipeArgs.builder()
    .networkId("string")
    .parameters(SmDevicesWipeParametersArgs.builder()
        .id("string")
        .pin(0)
        .serial("string")
        .wifiMac("string")
        .build())
    .build());
Copy
sm_devices_wipe_resource = meraki.networks.SmDevicesWipe("smDevicesWipeResource",
    network_id="string",
    parameters={
        "id": "string",
        "pin": 0,
        "serial": "string",
        "wifi_mac": "string",
    })
Copy
const smDevicesWipeResource = new meraki.networks.SmDevicesWipe("smDevicesWipeResource", {
    networkId: "string",
    parameters: {
        id: "string",
        pin: 0,
        serial: "string",
        wifiMac: "string",
    },
});
Copy
type: meraki:networks:SmDevicesWipe
properties:
    networkId: string
    parameters:
        id: string
        pin: 0
        serial: string
        wifiMac: string
Copy

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

NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. SmDevicesWipeParameters
NetworkId This property is required. string
networkId path parameter. Network ID
Parameters This property is required. SmDevicesWipeParametersArgs
networkId This property is required. String
networkId path parameter. Network ID
parameters This property is required. SmDevicesWipeParameters
networkId This property is required. string
networkId path parameter. Network ID
parameters This property is required. SmDevicesWipeParameters
network_id This property is required. str
networkId path parameter. Network ID
parameters This property is required. SmDevicesWipeParametersArgs
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 SmDevicesWipe resource produces the following output properties:

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

Look up Existing SmDevicesWipe Resource

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

Supporting Types

SmDevicesWipeItem
, SmDevicesWipeItemArgs

Id string
The Meraki Id of the devices.
Id string
The Meraki Id of the devices.
id String
The Meraki Id of the devices.
id string
The Meraki Id of the devices.
id str
The Meraki Id of the devices.
id String
The Meraki Id of the devices.

SmDevicesWipeParameters
, SmDevicesWipeParametersArgs

Id string
The id of the device to be wiped.
Pin int
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
Serial string
The serial of the device to be wiped.
WifiMac string
The wifiMac of the device to be wiped.
Id string
The id of the device to be wiped.
Pin int
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
Serial string
The serial of the device to be wiped.
WifiMac string
The wifiMac of the device to be wiped.
id String
The id of the device to be wiped.
pin Integer
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
serial String
The serial of the device to be wiped.
wifiMac String
The wifiMac of the device to be wiped.
id string
The id of the device to be wiped.
pin number
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
serial string
The serial of the device to be wiped.
wifiMac string
The wifiMac of the device to be wiped.
id str
The id of the device to be wiped.
pin int
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
serial str
The serial of the device to be wiped.
wifi_mac str
The wifiMac of the device to be wiped.
id String
The id of the device to be wiped.
pin Number
The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.
serial String
The serial of the device to be wiped.
wifiMac String
The wifiMac of the device to be wiped.

Package Details

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