Cisco Meraki v0.2.4, Jun 14 24

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.devices.LiveToolsWakeOnLan

Explore with Pulumi AI

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

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.devices.LiveToolsWakeOnLan;
import com.pulumi.meraki.devices.LiveToolsWakeOnLanArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsWakeOnLanCallbackArgs;
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 LiveToolsWakeOnLan("example", LiveToolsWakeOnLanArgs.builder()
            .callback(LiveToolsWakeOnLanCallbackArgs.builder()
                .http_server(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .payload_template(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .shared_secret("secret")
                .url("https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031")
                .build())
            .mac("00:11:22:33:44:55")
            .serial("string")
            .vlanId(12)
            .build());

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

resources:
  example:
    type: meraki:devices:LiveToolsWakeOnLan
    properties:
      callback:
        http_server:
          id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
        payload_template:
          id: wpt_2100
        shared_secret: secret
        url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
      mac: 00:11:22:33:44:55
      serial: string
      vlanId: 12
outputs:
  merakiDevicesLiveToolsWakeOnLanExample: ${example}

Create LiveToolsWakeOnLan Resource

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

Constructor syntax

new LiveToolsWakeOnLan(name: string, args: LiveToolsWakeOnLanArgs, opts?: CustomResourceOptions);

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

@overload
def LiveToolsWakeOnLan(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       serial: Optional[str] = None,
                       callback: Optional[LiveToolsWakeOnLanCallbackArgs] = None,
                       mac: Optional[str] = None,
                       vlan_id: Optional[int] = None,
                       wake_on_lan_id: Optional[str] = None)

func NewLiveToolsWakeOnLan(ctx *Context, name string, args LiveToolsWakeOnLanArgs, opts ...ResourceOption) (*LiveToolsWakeOnLan, error)

public LiveToolsWakeOnLan(string name, LiveToolsWakeOnLanArgs args, CustomResourceOptions? opts = null)

public LiveToolsWakeOnLan(String name, LiveToolsWakeOnLanArgs args)
public LiveToolsWakeOnLan(String name, LiveToolsWakeOnLanArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args LiveToolsWakeOnLanArgs: 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 liveToolsWakeOnLanResource = new Meraki.Devices.LiveToolsWakeOnLan("liveToolsWakeOnLanResource", new()
{
    Serial = "string",
    Callback = new Meraki.Devices.Inputs.LiveToolsWakeOnLanCallbackArgs
    {
        HttpServer = new Meraki.Devices.Inputs.LiveToolsWakeOnLanCallbackHttpServerArgs
        {
            Id = "string",
        },
        PayloadTemplate = new Meraki.Devices.Inputs.LiveToolsWakeOnLanCallbackPayloadTemplateArgs
        {
            Id = "string",
        },
        SharedSecret = "string",
        Url = "string",
    },
    Mac = "string",
    VlanId = 0,
    WakeOnLanId = "string",
});

example, err := devices.NewLiveToolsWakeOnLan(ctx, "liveToolsWakeOnLanResource", &devices.LiveToolsWakeOnLanArgs{
	Serial: pulumi.String("string"),
	Callback: &devices.LiveToolsWakeOnLanCallbackArgs{
		HttpServer: &devices.LiveToolsWakeOnLanCallbackHttpServerArgs{
			Id: pulumi.String("string"),
		},
		PayloadTemplate: &devices.LiveToolsWakeOnLanCallbackPayloadTemplateArgs{
			Id: pulumi.String("string"),
		},
		SharedSecret: pulumi.String("string"),
		Url:          pulumi.String("string"),
	},
	Mac:         pulumi.String("string"),
	VlanId:      pulumi.Int(0),
	WakeOnLanId: pulumi.String("string"),
})

var liveToolsWakeOnLanResource = new LiveToolsWakeOnLan("liveToolsWakeOnLanResource", LiveToolsWakeOnLanArgs.builder()
    .serial("string")
    .callback(LiveToolsWakeOnLanCallbackArgs.builder()
        .httpServer(LiveToolsWakeOnLanCallbackHttpServerArgs.builder()
            .id("string")
            .build())
        .payloadTemplate(LiveToolsWakeOnLanCallbackPayloadTemplateArgs.builder()
            .id("string")
            .build())
        .sharedSecret("string")
        .url("string")
        .build())
    .mac("string")
    .vlanId(0)
    .wakeOnLanId("string")
    .build());

live_tools_wake_on_lan_resource = meraki.devices.LiveToolsWakeOnLan("liveToolsWakeOnLanResource",
    serial="string",
    callback=meraki.devices.LiveToolsWakeOnLanCallbackArgs(
        http_server=meraki.devices.LiveToolsWakeOnLanCallbackHttpServerArgs(
            id="string",
        ),
        payload_template=meraki.devices.LiveToolsWakeOnLanCallbackPayloadTemplateArgs(
            id="string",
        ),
        shared_secret="string",
        url="string",
    ),
    mac="string",
    vlan_id=0,
    wake_on_lan_id="string")

const liveToolsWakeOnLanResource = new meraki.devices.LiveToolsWakeOnLan("liveToolsWakeOnLanResource", {
    serial: "string",
    callback: {
        httpServer: {
            id: "string",
        },
        payloadTemplate: {
            id: "string",
        },
        sharedSecret: "string",
        url: "string",
    },
    mac: "string",
    vlanId: 0,
    wakeOnLanId: "string",
});

type: meraki:devices:LiveToolsWakeOnLan
properties:
    callback:
        httpServer:
            id: string
        payloadTemplate:
            id: string
        sharedSecret: string
        url: string
    mac: string
    serial: string
    vlanId: 0
    wakeOnLanId: string

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

Serial string: serial path parameter.
Callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
Mac string: The target's MAC address
VlanId int: The target's VLAN (1 to 4094)
WakeOnLanId string: ID of the Wake-on-LAN job

Serial string: serial path parameter.
Callback LiveToolsWakeOnLanCallbackArgs: Details for the callback. Please include either an httpServerId OR url and sharedSecret
Mac string: The target's MAC address
VlanId int: The target's VLAN (1 to 4094)
WakeOnLanId string: ID of the Wake-on-LAN job

serial String: serial path parameter.
callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
mac String: The target's MAC address
vlanId Integer: The target's VLAN (1 to 4094)
wakeOnLanId String: ID of the Wake-on-LAN job

serial string: serial path parameter.
callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
mac string: The target's MAC address
vlanId number: The target's VLAN (1 to 4094)
wakeOnLanId string: ID of the Wake-on-LAN job

serial str: serial path parameter.
callback LiveToolsWakeOnLanCallbackArgs: Details for the callback. Please include either an httpServerId OR url and sharedSecret
mac str: The target's MAC address
vlan_id int: The target's VLAN (1 to 4094)
wake_on_lan_id str: ID of the Wake-on-LAN job

serial String: serial path parameter.
callback Property Map: Details for the callback. Please include either an httpServerId OR url and sharedSecret
mac String: The target's MAC address
vlanId Number: The target's VLAN (1 to 4094)
wakeOnLanId String: ID of the Wake-on-LAN job

Outputs

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

Error string: An error message for a failed execution
Id string: The provider-assigned unique ID for this managed resource.
Request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
Status string: Status of the Wake-on-LAN request
Url string: GET this url to check the status of your ping request

Error string: An error message for a failed execution
Id string: The provider-assigned unique ID for this managed resource.
Request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
Status string: Status of the Wake-on-LAN request
Url string: GET this url to check the status of your ping request

error String: An error message for a failed execution
id String: The provider-assigned unique ID for this managed resource.
request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
status String: Status of the Wake-on-LAN request
url String: GET this url to check the status of your ping request

error string: An error message for a failed execution
id string: The provider-assigned unique ID for this managed resource.
request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
status string: Status of the Wake-on-LAN request
url string: GET this url to check the status of your ping request

error str: An error message for a failed execution
id str: The provider-assigned unique ID for this managed resource.
request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
status str: Status of the Wake-on-LAN request
url str: GET this url to check the status of your ping request

error String: An error message for a failed execution
id String: The provider-assigned unique ID for this managed resource.
request Property Map: The parameters of the Wake-on-LAN request
status String: Status of the Wake-on-LAN request
url String: GET this url to check the status of your ping request

Look up Existing LiveToolsWakeOnLan Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        callback: Optional[LiveToolsWakeOnLanCallbackArgs] = None,
        error: Optional[str] = None,
        mac: Optional[str] = None,
        request: Optional[LiveToolsWakeOnLanRequestArgs] = None,
        serial: Optional[str] = None,
        status: Optional[str] = None,
        url: Optional[str] = None,
        vlan_id: Optional[int] = None,
        wake_on_lan_id: Optional[str] = None) -> LiveToolsWakeOnLan

func GetLiveToolsWakeOnLan(ctx *Context, name string, id IDInput, state *LiveToolsWakeOnLanState, opts ...ResourceOption) (*LiveToolsWakeOnLan, error)

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

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

Callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
Error string: An error message for a failed execution
Mac string: The target's MAC address
Request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
Serial string: serial path parameter.
Status string: Status of the Wake-on-LAN request
Url string: GET this url to check the status of your ping request
VlanId int: The target's VLAN (1 to 4094)
WakeOnLanId string: ID of the Wake-on-LAN job

Callback LiveToolsWakeOnLanCallbackArgs: Details for the callback. Please include either an httpServerId OR url and sharedSecret
Error string: An error message for a failed execution
Mac string: The target's MAC address
Request LiveToolsWakeOnLanRequestArgs: The parameters of the Wake-on-LAN request
Serial string: serial path parameter.
Status string: Status of the Wake-on-LAN request
Url string: GET this url to check the status of your ping request
VlanId int: The target's VLAN (1 to 4094)
WakeOnLanId string: ID of the Wake-on-LAN job

callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
error String: An error message for a failed execution
mac String: The target's MAC address
request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
serial String: serial path parameter.
status String: Status of the Wake-on-LAN request
url String: GET this url to check the status of your ping request
vlanId Integer: The target's VLAN (1 to 4094)
wakeOnLanId String: ID of the Wake-on-LAN job

callback LiveToolsWakeOnLanCallback: Details for the callback. Please include either an httpServerId OR url and sharedSecret
error string: An error message for a failed execution
mac string: The target's MAC address
request LiveToolsWakeOnLanRequest: The parameters of the Wake-on-LAN request
serial string: serial path parameter.
status string: Status of the Wake-on-LAN request
url string: GET this url to check the status of your ping request
vlanId number: The target's VLAN (1 to 4094)
wakeOnLanId string: ID of the Wake-on-LAN job

callback LiveToolsWakeOnLanCallbackArgs: Details for the callback. Please include either an httpServerId OR url and sharedSecret
error str: An error message for a failed execution
mac str: The target's MAC address
request LiveToolsWakeOnLanRequestArgs: The parameters of the Wake-on-LAN request
serial str: serial path parameter.
status str: Status of the Wake-on-LAN request
url str: GET this url to check the status of your ping request
vlan_id int: The target's VLAN (1 to 4094)
wake_on_lan_id str: ID of the Wake-on-LAN job

callback Property Map: Details for the callback. Please include either an httpServerId OR url and sharedSecret
error String: An error message for a failed execution
mac String: The target's MAC address
request Property Map: The parameters of the Wake-on-LAN request
serial String: serial path parameter.
status String: Status of the Wake-on-LAN request
url String: GET this url to check the status of your ping request
vlanId Number: The target's VLAN (1 to 4094)
wakeOnLanId String: ID of the Wake-on-LAN job

Supporting Types

LiveToolsWakeOnLanCallback, LiveToolsWakeOnLanCallbackArgs

HttpServer LiveToolsWakeOnLanCallbackHttpServer: The webhook receiver used for the callback webhook.
PayloadTemplate LiveToolsWakeOnLanCallbackPayloadTemplate: The payload template of the webhook used for the callback
SharedSecret string: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
Url string: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

HttpServer LiveToolsWakeOnLanCallbackHttpServer: The webhook receiver used for the callback webhook.
PayloadTemplate LiveToolsWakeOnLanCallbackPayloadTemplate: The payload template of the webhook used for the callback
SharedSecret string: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
Url string: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

httpServer LiveToolsWakeOnLanCallbackHttpServer: The webhook receiver used for the callback webhook.
payloadTemplate LiveToolsWakeOnLanCallbackPayloadTemplate: The payload template of the webhook used for the callback
sharedSecret String: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url String: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

httpServer LiveToolsWakeOnLanCallbackHttpServer: The webhook receiver used for the callback webhook.
payloadTemplate LiveToolsWakeOnLanCallbackPayloadTemplate: The payload template of the webhook used for the callback
sharedSecret string: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url string: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

http_server LiveToolsWakeOnLanCallbackHttpServer: The webhook receiver used for the callback webhook.
payload_template LiveToolsWakeOnLanCallbackPayloadTemplate: The payload template of the webhook used for the callback
shared_secret str: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url str: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

httpServer Property Map: The webhook receiver used for the callback webhook.
payloadTemplate Property Map: The payload template of the webhook used for the callback
sharedSecret String: A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
url String: The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

LiveToolsWakeOnLanCallbackHttpServer, LiveToolsWakeOnLanCallbackHttpServerArgs

Id string: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

Id string: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

id String: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

id string: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

id str: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

id String: The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

LiveToolsWakeOnLanCallbackPayloadTemplate, LiveToolsWakeOnLanCallbackPayloadTemplateArgs

Id string: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

Id string: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

id String: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

id string: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

id str: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

id String: The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

LiveToolsWakeOnLanRequest, LiveToolsWakeOnLanRequestArgs

Mac string: The target's MAC address
Serial string: Device serial number
VlanId int: The target's VLAN (1 to 4094)

Mac string: The target's MAC address
Serial string: Device serial number
VlanId int: The target's VLAN (1 to 4094)

mac String: The target's MAC address
serial String: Device serial number
vlanId Integer: The target's VLAN (1 to 4094)

mac string: The target's MAC address
serial string: Device serial number
vlanId number: The target's VLAN (1 to 4094)

mac str: The target's MAC address
serial str: Device serial number
vlan_id int: The target's VLAN (1 to 4094)

mac String: The target's MAC address
serial String: Device serial number
vlanId Number: The target's VLAN (1 to 4094)

Import

$ pulumi import meraki:devices/liveToolsWakeOnLan:LiveToolsWakeOnLan example "serial,wake_on_lan_id"

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.

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.devices.LiveToolsWakeOnLan

On this page

On this page

Example Usage

Create LiveToolsWakeOnLan Resource

Constructor syntax

Parameters

Constructor example

LiveToolsWakeOnLan Resource Properties

Inputs

Outputs

Look up Existing LiveToolsWakeOnLan Resource

Supporting Types

LiveToolsWakeOnLanCallback, LiveToolsWakeOnLanCallbackArgs

LiveToolsWakeOnLanCallbackHttpServer, LiveToolsWakeOnLanCallbackHttpServerArgs

LiveToolsWakeOnLanCallbackPayloadTemplate, LiveToolsWakeOnLanCallbackPayloadTemplateArgs

LiveToolsWakeOnLanRequest, LiveToolsWakeOnLanRequestArgs

Import

Package Details

On this page

On this page