1. Packages
  2. Netbox Provider
  3. API Docs
  4. getDevices
netbox 5.0.0 published on Friday, Sep 12, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.getDevices

Get Started
netbox logo
netbox 5.0.0 published on Friday, Sep 12, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    Using getDevices

    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 getDevices(args: GetDevicesArgs, opts?: InvokeOptions): Promise<GetDevicesResult>
function getDevicesOutput(args: GetDevicesOutputArgs, opts?: InvokeOptions): Output<GetDevicesResult>
    def get_devices(filters: Optional[Sequence[GetDevicesFilter]] = None,
                id: Optional[str] = None,
                limit: Optional[float] = None,
                name_regex: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDevicesResult
def get_devices_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDevicesFilterArgs]]]] = None,
                id: Optional[pulumi.Input[str]] = None,
                limit: Optional[pulumi.Input[float]] = None,
                name_regex: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDevicesResult]
    func GetDevices(ctx *Context, args *GetDevicesArgs, opts ...InvokeOption) (*GetDevicesResult, error)
func GetDevicesOutput(ctx *Context, args *GetDevicesOutputArgs, opts ...InvokeOption) GetDevicesResultOutput

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

    public static class GetDevices 
{
    public static Task<GetDevicesResult> InvokeAsync(GetDevicesArgs args, InvokeOptions? opts = null)
    public static Output<GetDevicesResult> Invoke(GetDevicesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDevicesResult> getDevices(GetDevicesArgs args, InvokeOptions options)
public static Output<GetDevicesResult> getDevices(GetDevicesArgs args, InvokeOptions options)

    fn::invoke:
  function: netbox:index/getDevices:getDevices
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetDevicesFilter>
    Id string
    The ID of this resource.
    Limit double
    NameRegex string
    Filters []GetDevicesFilter
    Id string
    The ID of this resource.
    Limit float64
    NameRegex string
    filters List<GetDevicesFilter>
    id String
    The ID of this resource.
    limit Double
    nameRegex String
    filters GetDevicesFilter[]
    id string
    The ID of this resource.
    limit number
    nameRegex string
    filters Sequence[GetDevicesFilter]
    id str
    The ID of this resource.
    limit float
    name_regex str
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    nameRegex String

    getDevices Result

    The following output properties are available:

    Devices []GetDevicesDevice
    Id string
    The ID of this resource.
    Filters []GetDevicesFilter
    Limit float64
    NameRegex string
    devices GetDevicesDevice[]
    id string
    The ID of this resource.
    filters GetDevicesFilter[]
    limit number
    nameRegex string
    devices List<Property Map>
    id String
    The ID of this resource.
    filters List<Property Map>
    limit Number
    nameRegex String

    Supporting Types

    GetDevicesDevice

    AssetTag string
    ClusterId double
    Comments string
    ConfigContext string
    CustomFields Dictionary<string, string>
    Description string
    DeviceId double
    DeviceTypeId double
    LocalContextData string
    LocationId double
    ManufacturerId double
    Model string
    Name string
    OobIp string
    PlatformId double
    PrimaryIpv4 string
    PrimaryIpv6 string
    RackFace string
    RackId double
    RackPosition double
    RoleId double
    Serial string
    SiteId double
    Status string
    Tags List<string>
    TenantId double
    AssetTag string
    ClusterId float64
    Comments string
    ConfigContext string
    CustomFields map[string]string
    Description string
    DeviceId float64
    DeviceTypeId float64
    LocalContextData string
    LocationId float64
    ManufacturerId float64
    Model string
    Name string
    OobIp string
    PlatformId float64
    PrimaryIpv4 string
    PrimaryIpv6 string
    RackFace string
    RackId float64
    RackPosition float64
    RoleId float64
    Serial string
    SiteId float64
    Status string
    Tags []string
    TenantId float64
    assetTag String
    clusterId Double
    comments String
    configContext String
    customFields Map<String,String>
    description String
    deviceId Double
    deviceTypeId Double
    localContextData String
    locationId Double
    manufacturerId Double
    model String
    name String
    oobIp String
    platformId Double
    primaryIpv4 String
    primaryIpv6 String
    rackFace String
    rackId Double
    rackPosition Double
    roleId Double
    serial String
    siteId Double
    status String
    tags List<String>
    tenantId Double
    assetTag string
    clusterId number
    comments string
    configContext string
    customFields {[key: string]: string}
    description string
    deviceId number
    deviceTypeId number
    localContextData string
    locationId number
    manufacturerId number
    model string
    name string
    oobIp string
    platformId number
    primaryIpv4 string
    primaryIpv6 string
    rackFace string
    rackId number
    rackPosition number
    roleId number
    serial string
    siteId number
    status string
    tags string[]
    tenantId number
    assetTag String
    clusterId Number
    comments String
    configContext String
    customFields Map<String>
    description String
    deviceId Number
    deviceTypeId Number
    localContextData String
    locationId Number
    manufacturerId Number
    model String
    name String
    oobIp String
    platformId Number
    primaryIpv4 String
    primaryIpv6 String
    rackFace String
    rackId Number
    rackPosition Number
    roleId Number
    serial String
    siteId Number
    status String
    tags List<String>
    tenantId Number

    GetDevicesFilter

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 5.0.0 published on Friday, Sep 12, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox
      Meet Neo: Your AI Platform Teammate