Cisco Meraki v0.3.2, Sep 24 24

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

meraki.networks.SmDevicesShutdown

Explore with Pulumi AI

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

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

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

resources:
  example:
    type: meraki:networks:SmDevicesShutdown
    properties:
      networkId: string
      parameters:
        ids:
          - '1284392014819'
          - '2983092129865'
        scope:
          - withAny
          - tag1
          - tag2
        serials:
          - XY0XX0Y0X0
          - A01B01CD00E
          - X02YZ1ZYZX
        wifi_macs:
          - 00:11:22:33:44:55
outputs:
  merakiNetworksSmDevicesShutdownExample: ${example}

Create SmDevicesShutdown Resource

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

Constructor syntax

new SmDevicesShutdown(name: string, args: SmDevicesShutdownArgs, opts?: CustomResourceOptions);

@overload
def SmDevicesShutdown(resource_name: str,
                      args: SmDevicesShutdownArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SmDevicesShutdown(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      network_id: Optional[str] = None,
                      parameters: Optional[SmDevicesShutdownParametersArgs] = None)

func NewSmDevicesShutdown(ctx *Context, name string, args SmDevicesShutdownArgs, opts ...ResourceOption) (*SmDevicesShutdown, error)

public SmDevicesShutdown(string name, SmDevicesShutdownArgs args, CustomResourceOptions? opts = null)

public SmDevicesShutdown(String name, SmDevicesShutdownArgs args)
public SmDevicesShutdown(String name, SmDevicesShutdownArgs args, CustomResourceOptions options)

type: meraki:networks:SmDevicesShutdown
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 SmDevicesShutdownArgs: 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 SmDevicesShutdownArgs: 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 SmDevicesShutdownArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SmDevicesShutdownArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SmDevicesShutdownArgs: 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 smDevicesShutdownResource = new Meraki.Networks.SmDevicesShutdown("smDevicesShutdownResource", new()
{
    NetworkId = "string",
    Parameters = new Meraki.Networks.Inputs.SmDevicesShutdownParametersArgs
    {
        Ids = new[]
        {
            "string",
        },
        Scopes = new[]
        {
            "string",
        },
        Serials = new[]
        {
            "string",
        },
        WifiMacs = new[]
        {
            "string",
        },
    },
});

example, err := networks.NewSmDevicesShutdown(ctx, "smDevicesShutdownResource", &networks.SmDevicesShutdownArgs{
	NetworkId: pulumi.String("string"),
	Parameters: &networks.SmDevicesShutdownParametersArgs{
		Ids: pulumi.StringArray{
			pulumi.String("string"),
		},
		Scopes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Serials: pulumi.StringArray{
			pulumi.String("string"),
		},
		WifiMacs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

var smDevicesShutdownResource = new SmDevicesShutdown("smDevicesShutdownResource", SmDevicesShutdownArgs.builder()
    .networkId("string")
    .parameters(SmDevicesShutdownParametersArgs.builder()
        .ids("string")
        .scopes("string")
        .serials("string")
        .wifiMacs("string")
        .build())
    .build());

sm_devices_shutdown_resource = meraki.networks.SmDevicesShutdown("smDevicesShutdownResource",
    network_id="string",
    parameters={
        "ids": ["string"],
        "scopes": ["string"],
        "serials": ["string"],
        "wifi_macs": ["string"],
    })

const smDevicesShutdownResource = new meraki.networks.SmDevicesShutdown("smDevicesShutdownResource", {
    networkId: "string",
    parameters: {
        ids: ["string"],
        scopes: ["string"],
        serials: ["string"],
        wifiMacs: ["string"],
    },
});

type: meraki:networks:SmDevicesShutdown
properties:
    networkId: string
    parameters:
        ids:
            - string
        scopes:
            - string
        serials:
            - string
        wifiMacs:
            - string

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

NetworkId string: networkId path parameter. Network ID
Parameters SmDevicesShutdownParameters

NetworkId string: networkId path parameter. Network ID
Parameters SmDevicesShutdownParametersArgs

networkId String: networkId path parameter. Network ID
parameters SmDevicesShutdownParameters

networkId string: networkId path parameter. Network ID
parameters SmDevicesShutdownParameters

network_id str: networkId path parameter. Network ID
parameters SmDevicesShutdownParametersArgs

networkId String: networkId path parameter. Network ID
parameters Property Map

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Item SmDevicesShutdownItem

Id string: The provider-assigned unique ID for this managed resource.
Item SmDevicesShutdownItem

id String: The provider-assigned unique ID for this managed resource.
item SmDevicesShutdownItem

id string: The provider-assigned unique ID for this managed resource.
item SmDevicesShutdownItem

id str: The provider-assigned unique ID for this managed resource.
item SmDevicesShutdownItem

id String: The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing SmDevicesShutdown Resource

Get an existing SmDevicesShutdown 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?: SmDevicesShutdownState, opts?: CustomResourceOptions): SmDevicesShutdown

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[SmDevicesShutdownItemArgs] = None,
        network_id: Optional[str] = None,
        parameters: Optional[SmDevicesShutdownParametersArgs] = None) -> SmDevicesShutdown

func GetSmDevicesShutdown(ctx *Context, name string, id IDInput, state *SmDevicesShutdownState, opts ...ResourceOption) (*SmDevicesShutdown, error)

public static SmDevicesShutdown Get(string name, Input<string> id, SmDevicesShutdownState? state, CustomResourceOptions? opts = null)

public static SmDevicesShutdown get(String name, Output<String> id, SmDevicesShutdownState 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:

Item SmDevicesShutdownItem
NetworkId string: networkId path parameter. Network ID
Parameters SmDevicesShutdownParameters

Item SmDevicesShutdownItemArgs
NetworkId string: networkId path parameter. Network ID
Parameters SmDevicesShutdownParametersArgs

item SmDevicesShutdownItem
networkId String: networkId path parameter. Network ID
parameters SmDevicesShutdownParameters

item SmDevicesShutdownItem
networkId string: networkId path parameter. Network ID
parameters SmDevicesShutdownParameters

item SmDevicesShutdownItemArgs
network_id str: networkId path parameter. Network ID
parameters SmDevicesShutdownParametersArgs

item Property Map
networkId String: networkId path parameter. Network ID
parameters Property Map

Supporting Types

SmDevicesShutdownItem, SmDevicesShutdownItemArgs

Ids List<string>: The Meraki Ids of the set of endpoints.

Ids []string: The Meraki Ids of the set of endpoints.

ids List<String>: The Meraki Ids of the set of endpoints.

ids string[]: The Meraki Ids of the set of endpoints.

ids Sequence[str]: The Meraki Ids of the set of endpoints.

ids List<String>: The Meraki Ids of the set of endpoints.

SmDevicesShutdownParameters, SmDevicesShutdownParametersArgs

Ids List<string>: The ids of the endpoints to be shutdown.
Scopes List<string>: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
Serials List<string>: The serials of the endpoints to be shutdown.
WifiMacs List<string>: The wifiMacs of the endpoints to be shutdown.

Ids []string: The ids of the endpoints to be shutdown.
Scopes []string: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
Serials []string: The serials of the endpoints to be shutdown.
WifiMacs []string: The wifiMacs of the endpoints to be shutdown.

ids List<String>: The ids of the endpoints to be shutdown.
scopes List<String>: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
serials List<String>: The serials of the endpoints to be shutdown.
wifiMacs List<String>: The wifiMacs of the endpoints to be shutdown.

ids string[]: The ids of the endpoints to be shutdown.
scopes string[]: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
serials string[]: The serials of the endpoints to be shutdown.
wifiMacs string[]: The wifiMacs of the endpoints to be shutdown.

ids Sequence[str]: The ids of the endpoints to be shutdown.
scopes Sequence[str]: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
serials Sequence[str]: The serials of the endpoints to be shutdown.
wifi_macs Sequence[str]: The wifiMacs of the endpoints to be shutdown.

ids List<String>: The ids of the endpoints to be shutdown.
scopes List<String>: The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.
serials List<String>: The serials of the endpoints to be shutdown.
wifiMacs List<String>: The wifiMacs of the endpoints to be shutdown.

Package Details

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

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

pulumi/pulumi-meraki

meraki.networks.SmDevicesShutdown

On this page

On this page

Example Usage

Create SmDevicesShutdown Resource

Constructor syntax

Parameters

Constructor example

SmDevicesShutdown Resource Properties

Inputs

Outputs

Look up Existing SmDevicesShutdown Resource

Supporting Types

SmDevicesShutdownItem, SmDevicesShutdownItemArgs

SmDevicesShutdownParameters, SmDevicesShutdownParametersArgs

Package Details

On this page

On this page