1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. SmDevicesReboot
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.networks.SmDevicesReboot

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 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.SmDevicesReboot;
    import com.pulumi.meraki.networks.SmDevicesRebootArgs;
    import com.pulumi.meraki.networks.inputs.SmDevicesRebootParametersArgs;
    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 SmDevicesReboot("example", SmDevicesRebootArgs.builder()
                .networkId("string")
                .parameters(SmDevicesRebootParametersArgs.builder()
                    .ids(                
                        "1284392014819",
                        "2983092129865")
                    .kext_paths("test")
                    .notify_user(true)
                    .rebuild_kernel_cache(true)
                    .request_requires_network_tether(true)
                    .scope(                
                        "withAny",
                        "tag1",
                        "tag2")
                    .serials(                
                        "XY0XX0Y0X0",
                        "A01B01CD00E",
                        "X02YZ1ZYZX")
                    .wifi_macs("00:11:22:33:44:55")
                    .build())
                .build());
    
            ctx.export("merakiNetworksSmDevicesRebootExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:SmDevicesReboot
        properties:
          networkId: string
          parameters:
            ids:
              - '1284392014819'
              - '2983092129865'
            kext_paths:
              - test
            notify_user: true
            rebuild_kernel_cache: true
            request_requires_network_tether: true
            scope:
              - withAny
              - tag1
              - tag2
            serials:
              - XY0XX0Y0X0
              - A01B01CD00E
              - X02YZ1ZYZX
            wifi_macs:
              - 00:11:22:33:44:55
    outputs:
      merakiNetworksSmDevicesRebootExample: ${example}
    

    Create SmDevicesReboot Resource

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

    Constructor syntax

    new SmDevicesReboot(name: string, args: SmDevicesRebootArgs, opts?: CustomResourceOptions);
    @overload
    def SmDevicesReboot(resource_name: str,
                        args: SmDevicesRebootArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SmDevicesReboot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        network_id: Optional[str] = None,
                        parameters: Optional[SmDevicesRebootParametersArgs] = None)
    func NewSmDevicesReboot(ctx *Context, name string, args SmDevicesRebootArgs, opts ...ResourceOption) (*SmDevicesReboot, error)
    public SmDevicesReboot(string name, SmDevicesRebootArgs args, CustomResourceOptions? opts = null)
    public SmDevicesReboot(String name, SmDevicesRebootArgs args)
    public SmDevicesReboot(String name, SmDevicesRebootArgs args, CustomResourceOptions options)
    
    type: meraki:networks:SmDevicesReboot
    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 SmDevicesRebootArgs
    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 SmDevicesRebootArgs
    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 SmDevicesRebootArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmDevicesRebootArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmDevicesRebootArgs
    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 smDevicesRebootResource = new Meraki.Networks.SmDevicesReboot("smDevicesRebootResource", new()
    {
        NetworkId = "string",
        Parameters = new Meraki.Networks.Inputs.SmDevicesRebootParametersArgs
        {
            Ids = new[]
            {
                "string",
            },
            KextPaths = new[]
            {
                "string",
            },
            NotifyUser = false,
            RebuildKernelCache = false,
            RequestRequiresNetworkTether = false,
            Scopes = new[]
            {
                "string",
            },
            Serials = new[]
            {
                "string",
            },
            WifiMacs = new[]
            {
                "string",
            },
        },
    });
    
    example, err := networks.NewSmDevicesReboot(ctx, "smDevicesRebootResource", &networks.SmDevicesRebootArgs{
    	NetworkId: pulumi.String("string"),
    	Parameters: &networks.SmDevicesRebootParametersArgs{
    		Ids: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		KextPaths: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		NotifyUser:                   pulumi.Bool(false),
    		RebuildKernelCache:           pulumi.Bool(false),
    		RequestRequiresNetworkTether: pulumi.Bool(false),
    		Scopes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Serials: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		WifiMacs: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    })
    
    var smDevicesRebootResource = new SmDevicesReboot("smDevicesRebootResource", SmDevicesRebootArgs.builder()
        .networkId("string")
        .parameters(SmDevicesRebootParametersArgs.builder()
            .ids("string")
            .kextPaths("string")
            .notifyUser(false)
            .rebuildKernelCache(false)
            .requestRequiresNetworkTether(false)
            .scopes("string")
            .serials("string")
            .wifiMacs("string")
            .build())
        .build());
    
    sm_devices_reboot_resource = meraki.networks.SmDevicesReboot("smDevicesRebootResource",
        network_id="string",
        parameters=meraki.networks.SmDevicesRebootParametersArgs(
            ids=["string"],
            kext_paths=["string"],
            notify_user=False,
            rebuild_kernel_cache=False,
            request_requires_network_tether=False,
            scopes=["string"],
            serials=["string"],
            wifi_macs=["string"],
        ))
    
    const smDevicesRebootResource = new meraki.networks.SmDevicesReboot("smDevicesRebootResource", {
        networkId: "string",
        parameters: {
            ids: ["string"],
            kextPaths: ["string"],
            notifyUser: false,
            rebuildKernelCache: false,
            requestRequiresNetworkTether: false,
            scopes: ["string"],
            serials: ["string"],
            wifiMacs: ["string"],
        },
    });
    
    type: meraki:networks:SmDevicesReboot
    properties:
        networkId: string
        parameters:
            ids:
                - string
            kextPaths:
                - string
            notifyUser: false
            rebuildKernelCache: false
            requestRequiresNetworkTether: false
            scopes:
                - string
            serials:
                - string
            wifiMacs:
                - string
    

    SmDevicesReboot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SmDevicesReboot resource accepts the following input properties:

    NetworkId string
    networkId path parameter. Network ID
    Parameters SmDevicesRebootParameters
    NetworkId string
    networkId path parameter. Network ID
    Parameters SmDevicesRebootParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters SmDevicesRebootParameters
    networkId string
    networkId path parameter. Network ID
    parameters SmDevicesRebootParameters
    network_id str
    networkId path parameter. Network ID
    parameters SmDevicesRebootParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters Property Map

    Outputs

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

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

    Look up Existing SmDevicesReboot Resource

    Get an existing SmDevicesReboot 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?: SmDevicesRebootState, opts?: CustomResourceOptions): SmDevicesReboot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            item: Optional[SmDevicesRebootItemArgs] = None,
            network_id: Optional[str] = None,
            parameters: Optional[SmDevicesRebootParametersArgs] = None) -> SmDevicesReboot
    func GetSmDevicesReboot(ctx *Context, name string, id IDInput, state *SmDevicesRebootState, opts ...ResourceOption) (*SmDevicesReboot, error)
    public static SmDevicesReboot Get(string name, Input<string> id, SmDevicesRebootState? state, CustomResourceOptions? opts = null)
    public static SmDevicesReboot get(String name, Output<String> id, SmDevicesRebootState 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 SmDevicesRebootItem
    NetworkId string
    networkId path parameter. Network ID
    Parameters SmDevicesRebootParameters
    item SmDevicesRebootItem
    networkId String
    networkId path parameter. Network ID
    parameters SmDevicesRebootParameters
    item SmDevicesRebootItem
    networkId string
    networkId path parameter. Network ID
    parameters SmDevicesRebootParameters
    item Property Map
    networkId String
    networkId path parameter. Network ID
    parameters Property Map

    Supporting Types

    SmDevicesRebootItem, SmDevicesRebootItemArgs

    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.

    SmDevicesRebootParameters, SmDevicesRebootParametersArgs

    Ids List<string>
    The ids of the endpoints to be rebooted.
    KextPaths List<string>
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    NotifyUser bool
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    RebuildKernelCache bool
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    RequestRequiresNetworkTether bool
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    Scopes List<string>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    Serials List<string>
    The serials of the endpoints to be rebooted.
    WifiMacs List<string>
    The wifiMacs of the endpoints to be rebooted.
    Ids []string
    The ids of the endpoints to be rebooted.
    KextPaths []string
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    NotifyUser bool
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    RebuildKernelCache bool
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    RequestRequiresNetworkTether bool
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    Scopes []string
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    Serials []string
    The serials of the endpoints to be rebooted.
    WifiMacs []string
    The wifiMacs of the endpoints to be rebooted.
    ids List<String>
    The ids of the endpoints to be rebooted.
    kextPaths List<String>
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    notifyUser Boolean
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    rebuildKernelCache Boolean
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    requestRequiresNetworkTether Boolean
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    scopes List<String>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    serials List<String>
    The serials of the endpoints to be rebooted.
    wifiMacs List<String>
    The wifiMacs of the endpoints to be rebooted.
    ids string[]
    The ids of the endpoints to be rebooted.
    kextPaths string[]
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    notifyUser boolean
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    rebuildKernelCache boolean
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    requestRequiresNetworkTether boolean
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    scopes string[]
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    serials string[]
    The serials of the endpoints to be rebooted.
    wifiMacs string[]
    The wifiMacs of the endpoints to be rebooted.
    ids Sequence[str]
    The ids of the endpoints to be rebooted.
    kext_paths Sequence[str]
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    notify_user bool
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    rebuild_kernel_cache bool
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    request_requires_network_tether bool
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    scopes Sequence[str]
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    serials Sequence[str]
    The serials of the endpoints to be rebooted.
    wifi_macs Sequence[str]
    The wifiMacs of the endpoints to be rebooted.
    ids List<String>
    The ids of the endpoints to be rebooted.
    kextPaths List<String>
    The KextPaths of the endpoints to be rebooted. Available for macOS 11+
    notifyUser Boolean
    Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+
    rebuildKernelCache Boolean
    Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+
    requestRequiresNetworkTether Boolean
    Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS
    scopes List<String>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.
    serials List<String>
    The serials of the endpoints to be rebooted.
    wifiMacs List<String>
    The wifiMacs of the endpoints to be rebooted.

    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.2.4 published on Friday, Jun 14, 2024 by Pulumi