Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. getDevice
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

sdwan.getDevice

Explore with Pulumi AI

Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

This data source can read the Device .

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sdwan from "@pulumi/sdwan";

const example = sdwan.getDevice({
    serialNumber: "12B53B6E42654E01B98C77C347CE216E",
    name: "Controller01",
});
Copy
import pulumi
import pulumi_sdwan as sdwan

example = sdwan.get_device(serial_number="12B53B6E42654E01B98C77C347CE216E",
    name="Controller01")
Copy
package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.GetDevice(ctx, &sdwan.GetDeviceArgs{
			SerialNumber: pulumi.StringRef("12B53B6E42654E01B98C77C347CE216E"),
			Name:         pulumi.StringRef("Controller01"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = Sdwan.GetDevice.Invoke(new()
    {
        SerialNumber = "12B53B6E42654E01B98C77C347CE216E",
        Name = "Controller01",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.SdwanFunctions;
import com.pulumi.sdwan.inputs.GetDeviceArgs;
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) {
        final var example = SdwanFunctions.getDevice(GetDeviceArgs.builder()
            .serialNumber("12B53B6E42654E01B98C77C347CE216E")
            .name("Controller01")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: sdwan:getDevice
      arguments:
        serialNumber: 12B53B6E42654E01B98C77C347CE216E
        name: Controller01
Copy

Using getDevice

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>
Copy
def get_device(name: Optional[str] = None,
               serial_number: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(name: Optional[pulumi.Input[str]] = None,
               serial_number: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
Copy
func GetDevice(ctx *Context, args *GetDeviceArgs, opts ...InvokeOption) (*GetDeviceResult, error)
func GetDeviceOutput(ctx *Context, args *GetDeviceOutputArgs, opts ...InvokeOption) GetDeviceResultOutput
Copy

> Note: This function is named GetDevice in the Go SDK.

public static class GetDevice 
{
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
public static Output<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: sdwan:index/getDevice:getDevice
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
The hostname of a device
SerialNumber string
Serial number for device. Could be board or virtual identifier
Name string
The hostname of a device
SerialNumber string
Serial number for device. Could be board or virtual identifier
name String
The hostname of a device
serialNumber String
Serial number for device. Could be board or virtual identifier
name string
The hostname of a device
serialNumber string
Serial number for device. Could be board or virtual identifier
name str
The hostname of a device
serial_number str
Serial number for device. Could be board or virtual identifier
name String
The hostname of a device
serialNumber String
Serial number for device. Could be board or virtual identifier

getDevice Result

The following output properties are available:

Devices List<GetDeviceDevice>
List of returned devices
Id string
The id of the object
Name string
The hostname of a device
SerialNumber string
Serial number for device. Could be board or virtual identifier
Devices []GetDeviceDevice
List of returned devices
Id string
The id of the object
Name string
The hostname of a device
SerialNumber string
Serial number for device. Could be board or virtual identifier
devices List<GetDeviceDevice>
List of returned devices
id String
The id of the object
name String
The hostname of a device
serialNumber String
Serial number for device. Could be board or virtual identifier
devices GetDeviceDevice[]
List of returned devices
id string
The id of the object
name string
The hostname of a device
serialNumber string
Serial number for device. Could be board or virtual identifier
devices Sequence[GetDeviceDevice]
List of returned devices
id str
The id of the object
name str
The hostname of a device
serial_number str
Serial number for device. Could be board or virtual identifier
devices List<Property Map>
List of returned devices
id String
The id of the object
name String
The hostname of a device
serialNumber String
Serial number for device. Could be board or virtual identifier

Supporting Types

GetDeviceDevice

DeviceId This property is required. string
The device ID as defined in SD-WAN Manager
Hostname This property is required. string
Hostname for respective device
Reachability This property is required. string
Reachability of device
SerialNumber This property is required. string
Serial number for device. Could be board or virtual identifier
SiteId This property is required. string
Site id for respective device
State This property is required. string
State for respective device
Status This property is required. string
Status for respective device
Uuid This property is required. string
Unique identifier for device
DeviceId This property is required. string
The device ID as defined in SD-WAN Manager
Hostname This property is required. string
Hostname for respective device
Reachability This property is required. string
Reachability of device
SerialNumber This property is required. string
Serial number for device. Could be board or virtual identifier
SiteId This property is required. string
Site id for respective device
State This property is required. string
State for respective device
Status This property is required. string
Status for respective device
Uuid This property is required. string
Unique identifier for device
deviceId This property is required. String
The device ID as defined in SD-WAN Manager
hostname This property is required. String
Hostname for respective device
reachability This property is required. String
Reachability of device
serialNumber This property is required. String
Serial number for device. Could be board or virtual identifier
siteId This property is required. String
Site id for respective device
state This property is required. String
State for respective device
status This property is required. String
Status for respective device
uuid This property is required. String
Unique identifier for device
deviceId This property is required. string
The device ID as defined in SD-WAN Manager
hostname This property is required. string
Hostname for respective device
reachability This property is required. string
Reachability of device
serialNumber This property is required. string
Serial number for device. Could be board or virtual identifier
siteId This property is required. string
Site id for respective device
state This property is required. string
State for respective device
status This property is required. string
Status for respective device
uuid This property is required. string
Unique identifier for device
device_id This property is required. str
The device ID as defined in SD-WAN Manager
hostname This property is required. str
Hostname for respective device
reachability This property is required. str
Reachability of device
serial_number This property is required. str
Serial number for device. Could be board or virtual identifier
site_id This property is required. str
Site id for respective device
state This property is required. str
State for respective device
status This property is required. str
Status for respective device
uuid This property is required. str
Unique identifier for device
deviceId This property is required. String
The device ID as defined in SD-WAN Manager
hostname This property is required. String
Hostname for respective device
reachability This property is required. String
Reachability of device
serialNumber This property is required. String
Serial number for device. Could be board or virtual identifier
siteId This property is required. String
Site id for respective device
state This property is required. String
State for respective device
status This property is required. String
Status for respective device
uuid This property is required. String
Unique identifier for device

Package Details

Repository
sdwan pulumi/pulumi-sdwan
License
Apache-2.0
Notes
This Pulumi package is based on the sdwan Terraform Provider.
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan