1. Packages
  2. Equinix
  3. API Docs
  4. networkedge
  5. getDevice
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

equinix.networkedge.getDevice

Explore with Pulumi AI

Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

Use this data source to get Equinix Network Edge device details.

Example Usage

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

const byUuid = equinix.networkedge.getDevice({
    uuid: "f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee",
});
const byName = equinix.networkedge.getDevice({
    name: "Arcus-Gateway-A1",
});
Copy
import pulumi
import pulumi_equinix as equinix

by_uuid = equinix.networkedge.get_device(uuid="f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee")
by_name = equinix.networkedge.get_device(name="Arcus-Gateway-A1")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkedge.LookupDevice(ctx, &networkedge.LookupDeviceArgs{
			Uuid: pulumi.StringRef("f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = networkedge.LookupDevice(ctx, &networkedge.LookupDeviceArgs{
			Name: pulumi.StringRef("Arcus-Gateway-A1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var byUuid = Equinix.NetworkEdge.GetDevice.Invoke(new()
    {
        Uuid = "f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee",
    });

    var byName = Equinix.NetworkEdge.GetDevice.Invoke(new()
    {
        Name = "Arcus-Gateway-A1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.networkedge.NetworkedgeFunctions;
import com.pulumi.equinix.networkedge.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 byUuid = NetworkedgeFunctions.getDevice(GetDeviceArgs.builder()
            .uuid("f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee")
            .build());

        final var byName = NetworkedgeFunctions.getDevice(GetDeviceArgs.builder()
            .name("Arcus-Gateway-A1")
            .build());

    }
}
Copy
variables:
  byUuid:
    fn::invoke:
      function: equinix:networkedge:getDevice
      arguments:
        uuid: f0b5c553-cdeb-4bc3-95b8-23db9ccfd5ee
  byName:
    fn::invoke:
      function: equinix:networkedge:getDevice
      arguments:
        name: Arcus-Gateway-A1
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,
               uuid: Optional[str] = None,
               valid_status_list: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(name: Optional[pulumi.Input[str]] = None,
               uuid: Optional[pulumi.Input[str]] = None,
               valid_status_list: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
Copy
func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput
Copy

> Note: This function is named LookupDevice 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: equinix:networkedge/getDevice:getDevice
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
Name of an existing Equinix Network Edge device
Uuid string
UUID of an existing Equinix Network Edge device
ValidStatusList string

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

Name string
Name of an existing Equinix Network Edge device
Uuid string
UUID of an existing Equinix Network Edge device
ValidStatusList string

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

name String
Name of an existing Equinix Network Edge device
uuid String
UUID of an existing Equinix Network Edge device
validStatusList String

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

name string
Name of an existing Equinix Network Edge device
uuid string
UUID of an existing Equinix Network Edge device
validStatusList string

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

name str
Name of an existing Equinix Network Edge device
uuid str
UUID of an existing Equinix Network Edge device
valid_status_list str

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

name String
Name of an existing Equinix Network Edge device
uuid String
UUID of an existing Equinix Network Edge device
validStatusList String

Device states to be considered valid when searching for a device by name

NOTE: Exactly one of either uuid or name must be specified.

getDevice Result

The following output properties are available:

AccountNumber string
AclTemplateId string
Unique identifier of applied ACL template
AdditionalBandwidth int
Asn int
Autonomous system number
Byol bool
ClusterDetails List<GetDeviceClusterDetail>
Connectivity string
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
CoreCount int
DiverseDeviceId string
diverse device uuid
DiverseDeviceName string
Name of the device with diverse device UUID
Hostname string
Ibx string
Device location Equinix Business Exchange name
Id string
The provider-assigned unique ID for this managed resource.
InterfaceCount int
Interfaces List<GetDeviceInterface>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
LicenseFile string
LicenseFileId string
Unique identifier of applied license file
LicenseStatus string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
LicenseToken string
MetroCode string
MgmtAclTemplateUuid string
Name string
Notifications List<string>
OrderReference string
PackageCode string
ProjectId string
PurchaseOrderNumber string
RedundancyType string
Device redundancy type applicable for HA devices, either primary or secondary
RedundantId string
Unique identifier for a redundant device applicable for HA devices
Region string
Device location region
SecondaryDevices List<GetDeviceSecondaryDevice>
SelfManaged bool
SshIpAddress string
IP address of SSH enabled interface on the device
SshIpFqdn string
FQDN of SSH enabled interface on the device
SshKeys List<GetDeviceSshKey>
Status string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
TermLength int
Throughput int
ThroughputUnit string
Tier int
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
TypeCode string
Uuid string
Device unique identifier
VendorConfiguration Dictionary<string, string>
Version string
WanInterfaceId string
ZoneCode string
Device location zone code
ValidStatusList string
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.
AccountNumber string
AclTemplateId string
Unique identifier of applied ACL template
AdditionalBandwidth int
Asn int
Autonomous system number
Byol bool
ClusterDetails []GetDeviceClusterDetail
Connectivity string
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
CoreCount int
DiverseDeviceId string
diverse device uuid
DiverseDeviceName string
Name of the device with diverse device UUID
Hostname string
Ibx string
Device location Equinix Business Exchange name
Id string
The provider-assigned unique ID for this managed resource.
InterfaceCount int
Interfaces []GetDeviceInterface
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
LicenseFile string
LicenseFileId string
Unique identifier of applied license file
LicenseStatus string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
LicenseToken string
MetroCode string
MgmtAclTemplateUuid string
Name string
Notifications []string
OrderReference string
PackageCode string
ProjectId string
PurchaseOrderNumber string
RedundancyType string
Device redundancy type applicable for HA devices, either primary or secondary
RedundantId string
Unique identifier for a redundant device applicable for HA devices
Region string
Device location region
SecondaryDevices []GetDeviceSecondaryDevice
SelfManaged bool
SshIpAddress string
IP address of SSH enabled interface on the device
SshIpFqdn string
FQDN of SSH enabled interface on the device
SshKeys []GetDeviceSshKey
Status string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
TermLength int
Throughput int
ThroughputUnit string
Tier int
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
TypeCode string
Uuid string
Device unique identifier
VendorConfiguration map[string]string
Version string
WanInterfaceId string
ZoneCode string
Device location zone code
ValidStatusList string
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.
accountNumber String
aclTemplateId String
Unique identifier of applied ACL template
additionalBandwidth Integer
asn Integer
Autonomous system number
byol Boolean
clusterDetails List<GetDeviceClusterDetail>
connectivity String
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
coreCount Integer
diverseDeviceId String
diverse device uuid
diverseDeviceName String
Name of the device with diverse device UUID
hostname String
ibx String
Device location Equinix Business Exchange name
id String
The provider-assigned unique ID for this managed resource.
interfaceCount Integer
interfaces List<GetDeviceInterface>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile String
licenseFileId String
Unique identifier of applied license file
licenseStatus String
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken String
metroCode String
mgmtAclTemplateUuid String
name String
notifications List<String>
orderReference String
packageCode String
projectId String
purchaseOrderNumber String
redundancyType String
Device redundancy type applicable for HA devices, either primary or secondary
redundantId String
Unique identifier for a redundant device applicable for HA devices
region String
Device location region
secondaryDevices List<GetDeviceSecondaryDevice>
selfManaged Boolean
sshIpAddress String
IP address of SSH enabled interface on the device
sshIpFqdn String
FQDN of SSH enabled interface on the device
sshKeys List<GetDeviceSshKey>
status String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
termLength Integer
throughput Integer
throughputUnit String
tier Integer
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
typeCode String
uuid String
Device unique identifier
vendorConfiguration Map<String,String>
version String
wanInterfaceId String
zoneCode String
Device location zone code
validStatusList String
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.
accountNumber string
aclTemplateId string
Unique identifier of applied ACL template
additionalBandwidth number
asn number
Autonomous system number
byol boolean
clusterDetails GetDeviceClusterDetail[]
connectivity string
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
coreCount number
diverseDeviceId string
diverse device uuid
diverseDeviceName string
Name of the device with diverse device UUID
hostname string
ibx string
Device location Equinix Business Exchange name
id string
The provider-assigned unique ID for this managed resource.
interfaceCount number
interfaces GetDeviceInterface[]
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile string
licenseFileId string
Unique identifier of applied license file
licenseStatus string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken string
metroCode string
mgmtAclTemplateUuid string
name string
notifications string[]
orderReference string
packageCode string
projectId string
purchaseOrderNumber string
redundancyType string
Device redundancy type applicable for HA devices, either primary or secondary
redundantId string
Unique identifier for a redundant device applicable for HA devices
region string
Device location region
secondaryDevices GetDeviceSecondaryDevice[]
selfManaged boolean
sshIpAddress string
IP address of SSH enabled interface on the device
sshIpFqdn string
FQDN of SSH enabled interface on the device
sshKeys GetDeviceSshKey[]
status string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
termLength number
throughput number
throughputUnit string
tier number
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
typeCode string
uuid string
Device unique identifier
vendorConfiguration {[key: string]: string}
version string
wanInterfaceId string
zoneCode string
Device location zone code
validStatusList string
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.
account_number str
acl_template_id str
Unique identifier of applied ACL template
additional_bandwidth int
asn int
Autonomous system number
byol bool
cluster_details Sequence[GetDeviceClusterDetail]
connectivity str
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
core_count int
diverse_device_id str
diverse device uuid
diverse_device_name str
Name of the device with diverse device UUID
hostname str
ibx str
Device location Equinix Business Exchange name
id str
The provider-assigned unique ID for this managed resource.
interface_count int
interfaces Sequence[GetDeviceInterface]
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
license_file str
license_file_id str
Unique identifier of applied license file
license_status str
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
license_token str
metro_code str
mgmt_acl_template_uuid str
name str
notifications Sequence[str]
order_reference str
package_code str
project_id str
purchase_order_number str
redundancy_type str
Device redundancy type applicable for HA devices, either primary or secondary
redundant_id str
Unique identifier for a redundant device applicable for HA devices
region str
Device location region
secondary_devices Sequence[GetDeviceSecondaryDevice]
self_managed bool
ssh_ip_address str
IP address of SSH enabled interface on the device
ssh_ip_fqdn str
FQDN of SSH enabled interface on the device
ssh_keys Sequence[GetDeviceSshKey]
status str
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
term_length int
throughput int
throughput_unit str
tier int
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
type_code str
uuid str
Device unique identifier
vendor_configuration Mapping[str, str]
version str
wan_interface_id str
zone_code str
Device location zone code
valid_status_list str
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.
accountNumber String
aclTemplateId String
Unique identifier of applied ACL template
additionalBandwidth Number
asn Number
Autonomous system number
byol Boolean
clusterDetails List<Property Map>
connectivity String
Device accessibility (INTERNET-ACCESS or PRIVATE or INTERNET-ACCESS-WITH-PRVT-MGMT)
coreCount Number
diverseDeviceId String
diverse device uuid
diverseDeviceName String
Name of the device with diverse device UUID
hostname String
ibx String
Device location Equinix Business Exchange name
id String
The provider-assigned unique ID for this managed resource.
interfaceCount Number
interfaces List<Property Map>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile String
licenseFileId String
Unique identifier of applied license file
licenseStatus String
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken String
metroCode String
mgmtAclTemplateUuid String
name String
notifications List<String>
orderReference String
packageCode String
projectId String
purchaseOrderNumber String
redundancyType String
Device redundancy type applicable for HA devices, either primary or secondary
redundantId String
Unique identifier for a redundant device applicable for HA devices
region String
Device location region
secondaryDevices List<Property Map>
selfManaged Boolean
sshIpAddress String
IP address of SSH enabled interface on the device
sshIpFqdn String
FQDN of SSH enabled interface on the device
sshKeys List<Property Map>
status String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
termLength Number
throughput Number
throughputUnit String
tier Number
Throughput Tier (applicable for C8000V, C8000V-SDWAN devices)
typeCode String
uuid String
Device unique identifier
vendorConfiguration Map<String>
version String
wanInterfaceId String
zoneCode String
Device location zone code
validStatusList String
Comma separated list of device states (from see status for full list) to be considered valid. Default is 'PROVISIONED'. Case insensitive.

Supporting Types

GetDeviceClusterDetail

ClusterId This property is required. string
The id of the cluster
ClusterName This property is required. string
The name of the cluster device
Node0s This property is required. List<GetDeviceClusterDetailNode0>
An object that has node0 details
Node1s This property is required. List<GetDeviceClusterDetailNode1>
An object that has node1 details
NumOfNodes This property is required. int
The number of nodes in the cluster
ClusterId This property is required. string
The id of the cluster
ClusterName This property is required. string
The name of the cluster device
Node0s This property is required. []GetDeviceClusterDetailNode0
An object that has node0 details
Node1s This property is required. []GetDeviceClusterDetailNode1
An object that has node1 details
NumOfNodes This property is required. int
The number of nodes in the cluster
clusterId This property is required. String
The id of the cluster
clusterName This property is required. String
The name of the cluster device
node0s This property is required. List<GetDeviceClusterDetailNode0>
An object that has node0 details
node1s This property is required. List<GetDeviceClusterDetailNode1>
An object that has node1 details
numOfNodes This property is required. Integer
The number of nodes in the cluster
clusterId This property is required. string
The id of the cluster
clusterName This property is required. string
The name of the cluster device
node0s This property is required. GetDeviceClusterDetailNode0[]
An object that has node0 details
node1s This property is required. GetDeviceClusterDetailNode1[]
An object that has node1 details
numOfNodes This property is required. number
The number of nodes in the cluster
cluster_id This property is required. str
The id of the cluster
cluster_name This property is required. str
The name of the cluster device
node0s This property is required. Sequence[GetDeviceClusterDetailNode0]
An object that has node0 details
node1s This property is required. Sequence[GetDeviceClusterDetailNode1]
An object that has node1 details
num_of_nodes This property is required. int
The number of nodes in the cluster
clusterId This property is required. String
The id of the cluster
clusterName This property is required. String
The name of the cluster device
node0s This property is required. List<Property Map>
An object that has node0 details
node1s This property is required. List<Property Map>
An object that has node1 details
numOfNodes This property is required. Number
The number of nodes in the cluster

GetDeviceClusterDetailNode0

LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
Name This property is required. string
Name of an existing Equinix Network Edge device
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfigurations This property is required. List<GetDeviceClusterDetailNode0VendorConfiguration>
An object that has fields relevant to the vendor of the cluster device
LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
Name This property is required. string
Name of an existing Equinix Network Edge device
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfigurations This property is required. []GetDeviceClusterDetailNode0VendorConfiguration
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. String
Unique identifier of applied license file
licenseToken This property is required. String
License token. This is necessary for Palo Alto clusters
name This property is required. String
Name of an existing Equinix Network Edge device
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. List<GetDeviceClusterDetailNode0VendorConfiguration>
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. string
Unique identifier of applied license file
licenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
name This property is required. string
Name of an existing Equinix Network Edge device
uuid This property is required. string
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. GetDeviceClusterDetailNode0VendorConfiguration[]
An object that has fields relevant to the vendor of the cluster device
license_file_id This property is required. str
Unique identifier of applied license file
license_token This property is required. str
License token. This is necessary for Palo Alto clusters
name This property is required. str
Name of an existing Equinix Network Edge device
uuid This property is required. str
UUID of an existing Equinix Network Edge device
vendor_configurations This property is required. Sequence[GetDeviceClusterDetailNode0VendorConfiguration]
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. String
Unique identifier of applied license file
licenseToken This property is required. String
License token. This is necessary for Palo Alto clusters
name This property is required. String
Name of an existing Equinix Network Edge device
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. List<Property Map>
An object that has fields relevant to the vendor of the cluster device

GetDeviceClusterDetailNode0VendorConfiguration

ActivationKey This property is required. string
Activation key. This is required for Velocloud clusters
AdminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
Controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
ControllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
Hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
LicenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
LicenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
PanoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
PanoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
PrivateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
RootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
ActivationKey This property is required. string
Activation key. This is required for Velocloud clusters
AdminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
Controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
ControllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
Hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
LicenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
LicenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
PanoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
PanoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
PrivateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
RootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. String
Activation key. This is required for Velocloud clusters
adminPassword This property is required. String
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. String
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. String
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. String
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. String
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. String
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. String
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. String
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. String
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. String
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. String
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. string
Activation key. This is required for Velocloud clusters
adminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activation_key This property is required. str
Activation key. This is required for Velocloud clusters
admin_password This property is required. str
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. str
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controller_fqdn This property is required. str
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. str
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
license_id This property is required. str
License id. This field is relevant only for the BlueCat DNS and DHCP Server
license_key This property is required. str
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panorama_auth_key This property is required. str
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panorama_ip_address This property is required. str
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
private_address This property is required. str
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
private_cidr_mask This property is required. str
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
private_gateway This property is required. str
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
root_password This property is required. str
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. String
Activation key. This is required for Velocloud clusters
adminPassword This property is required. String
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. String
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. String
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. String
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. String
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. String
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. String
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. String
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. String
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. String
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. String
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster

GetDeviceClusterDetailNode1

LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
Name This property is required. string
Name of an existing Equinix Network Edge device
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfigurations This property is required. List<GetDeviceClusterDetailNode1VendorConfiguration>
An object that has fields relevant to the vendor of the cluster device
LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
Name This property is required. string
Name of an existing Equinix Network Edge device
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfigurations This property is required. []GetDeviceClusterDetailNode1VendorConfiguration
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. String
Unique identifier of applied license file
licenseToken This property is required. String
License token. This is necessary for Palo Alto clusters
name This property is required. String
Name of an existing Equinix Network Edge device
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. List<GetDeviceClusterDetailNode1VendorConfiguration>
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. string
Unique identifier of applied license file
licenseToken This property is required. string
License token. This is necessary for Palo Alto clusters
name This property is required. string
Name of an existing Equinix Network Edge device
uuid This property is required. string
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. GetDeviceClusterDetailNode1VendorConfiguration[]
An object that has fields relevant to the vendor of the cluster device
license_file_id This property is required. str
Unique identifier of applied license file
license_token This property is required. str
License token. This is necessary for Palo Alto clusters
name This property is required. str
Name of an existing Equinix Network Edge device
uuid This property is required. str
UUID of an existing Equinix Network Edge device
vendor_configurations This property is required. Sequence[GetDeviceClusterDetailNode1VendorConfiguration]
An object that has fields relevant to the vendor of the cluster device
licenseFileId This property is required. String
Unique identifier of applied license file
licenseToken This property is required. String
License token. This is necessary for Palo Alto clusters
name This property is required. String
Name of an existing Equinix Network Edge device
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfigurations This property is required. List<Property Map>
An object that has fields relevant to the vendor of the cluster device

GetDeviceClusterDetailNode1VendorConfiguration

ActivationKey This property is required. string
Activation key. This is required for Velocloud clusters
AdminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
Controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
ControllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
Hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
LicenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
LicenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
PanoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
PanoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
PrivateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
RootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
ActivationKey This property is required. string
Activation key. This is required for Velocloud clusters
AdminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
Controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
ControllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
Hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
LicenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
LicenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
PanoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
PanoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
PrivateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
PrivateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
RootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. String
Activation key. This is required for Velocloud clusters
adminPassword This property is required. String
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. String
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. String
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. String
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. String
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. String
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. String
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. String
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. String
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. String
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. String
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. string
Activation key. This is required for Velocloud clusters
adminPassword This property is required. string
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. string
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. string
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. string
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. string
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. string
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. string
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. string
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. string
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. string
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. string
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activation_key This property is required. str
Activation key. This is required for Velocloud clusters
admin_password This property is required. str
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. str
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controller_fqdn This property is required. str
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. str
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
license_id This property is required. str
License id. This field is relevant only for the BlueCat DNS and DHCP Server
license_key This property is required. str
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panorama_auth_key This property is required. str
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panorama_ip_address This property is required. str
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
private_address This property is required. str
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
private_cidr_mask This property is required. str
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
private_gateway This property is required. str
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
root_password This property is required. str
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
activationKey This property is required. String
Activation key. This is required for Velocloud clusters
adminPassword This property is required. String
The administrative password of the device. You can use it to log in to the console. This field is not available for all device types
controller1 This property is required. String
System IP Address. Mandatory for the Fortinet SDWAN cluster device
controllerFqdn This property is required. String
Controller fqdn. This is required for Velocloud clusters
hostname This property is required. String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
licenseId This property is required. String
License id. This field is relevant only for the BlueCat DNS and DHCP Server
licenseKey This property is required. String
License key. This field is relevant only for the BlueCat DNS and DHCP Server
panoramaAuthKey This property is required. String
Panorama Server Auth Key. This field is relevant only for Palo Alto Networks Firewall devices
panoramaIpAddress This property is required. String
Panorama Server IP Address. This field is relevant only for Palo Alto Networks Firewall devices
privateAddress This property is required. String
Private address. This field is relevant only for the BlueCat DNS and DHCP Server
privateCidrMask This property is required. String
Private CIDR Mask. This field is relevant only for the BlueCat DNS and DHCP Server
privateGateway This property is required. String
Private gateway. This field is relevant only for the BlueCat DNS and DHCP Server
rootPassword This property is required. String
The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster

GetDeviceInterface

AssignedType This property is required. string
Interface management type (Equinix Managed or empty)
Id This property is required. int
Interface identifier
IpAddress This property is required. string
interface IP address
MacAddress This property is required. string
Interface MAC addres
Name This property is required. string
Name of an existing Equinix Network Edge device
OperationalStatus This property is required. string
Interface operational status (up or down)
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Type This property is required. string
Interface type
AssignedType This property is required. string
Interface management type (Equinix Managed or empty)
Id This property is required. int
Interface identifier
IpAddress This property is required. string
interface IP address
MacAddress This property is required. string
Interface MAC addres
Name This property is required. string
Name of an existing Equinix Network Edge device
OperationalStatus This property is required. string
Interface operational status (up or down)
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Type This property is required. string
Interface type
assignedType This property is required. String
Interface management type (Equinix Managed or empty)
id This property is required. Integer
Interface identifier
ipAddress This property is required. String
interface IP address
macAddress This property is required. String
Interface MAC addres
name This property is required. String
Name of an existing Equinix Network Edge device
operationalStatus This property is required. String
Interface operational status (up or down)
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. String
Interface type
assignedType This property is required. string
Interface management type (Equinix Managed or empty)
id This property is required. number
Interface identifier
ipAddress This property is required. string
interface IP address
macAddress This property is required. string
Interface MAC addres
name This property is required. string
Name of an existing Equinix Network Edge device
operationalStatus This property is required. string
Interface operational status (up or down)
status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. string
Interface type
assigned_type This property is required. str
Interface management type (Equinix Managed or empty)
id This property is required. int
Interface identifier
ip_address This property is required. str
interface IP address
mac_address This property is required. str
Interface MAC addres
name This property is required. str
Name of an existing Equinix Network Edge device
operational_status This property is required. str
Interface operational status (up or down)
status This property is required. str
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. str
Interface type
assignedType This property is required. String
Interface management type (Equinix Managed or empty)
id This property is required. Number
Interface identifier
ipAddress This property is required. String
interface IP address
macAddress This property is required. String
Interface MAC addres
name This property is required. String
Name of an existing Equinix Network Edge device
operationalStatus This property is required. String
Interface operational status (up or down)
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. String
Interface type

GetDeviceSecondaryDevice

AccountNumber This property is required. string
Device billing account number
AclTemplateId This property is required. string
Unique identifier of applied ACL template
AdditionalBandwidth This property is required. int
Additional Internet bandwidth, in Mbps, that will be allocated to the device
Asn This property is required. int
Autonomous system number
CloudInitFileId This property is required. string
Unique identifier of applied cloud init file
Hostname This property is required. string
Device hostname prefix
Ibx This property is required. string
Device location Equinix Business Exchange name
Interfaces This property is required. List<GetDeviceSecondaryDeviceInterface>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
LicenseFile This property is required. string
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseStatus This property is required. string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
LicenseToken This property is required. string
License Token applicable for some device types in BYOL licensing mode
MetroCode This property is required. string
Device location metro code
MgmtAclTemplateUuid This property is required. string
Unique identifier of applied MGMT ACL template
Name This property is required. string
Name of an existing Equinix Network Edge device
Notifications This property is required. List<string>
List of email addresses that will receive device status notifications
ProjectId This property is required. string
The unique identifier of Project Resource to which device is scoped to
RedundancyType This property is required. string
Device redundancy type applicable for HA devices, either primary or secondary
RedundantId This property is required. string
Unique identifier for a redundant device applicable for HA devices
Region This property is required. string
Device location region
SshIpAddress This property is required. string
IP address of SSH enabled interface on the device
SshIpFqdn This property is required. string
FQDN of SSH enabled interface on the device
SshKeys This property is required. List<GetDeviceSecondaryDeviceSshKey>
Definition of SSH key that will be provisioned on a device
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfiguration This property is required. Dictionary<string, string>
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
WanInterfaceId This property is required. string
device interface id picked for WAN
ZoneCode This property is required. string
Device location zone code
AccountNumber This property is required. string
Device billing account number
AclTemplateId This property is required. string
Unique identifier of applied ACL template
AdditionalBandwidth This property is required. int
Additional Internet bandwidth, in Mbps, that will be allocated to the device
Asn This property is required. int
Autonomous system number
CloudInitFileId This property is required. string
Unique identifier of applied cloud init file
Hostname This property is required. string
Device hostname prefix
Ibx This property is required. string
Device location Equinix Business Exchange name
Interfaces This property is required. []GetDeviceSecondaryDeviceInterface
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
LicenseFile This property is required. string
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
LicenseFileId This property is required. string
Unique identifier of applied license file
LicenseStatus This property is required. string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
LicenseToken This property is required. string
License Token applicable for some device types in BYOL licensing mode
MetroCode This property is required. string
Device location metro code
MgmtAclTemplateUuid This property is required. string
Unique identifier of applied MGMT ACL template
Name This property is required. string
Name of an existing Equinix Network Edge device
Notifications This property is required. []string
List of email addresses that will receive device status notifications
ProjectId This property is required. string
The unique identifier of Project Resource to which device is scoped to
RedundancyType This property is required. string
Device redundancy type applicable for HA devices, either primary or secondary
RedundantId This property is required. string
Unique identifier for a redundant device applicable for HA devices
Region This property is required. string
Device location region
SshIpAddress This property is required. string
IP address of SSH enabled interface on the device
SshIpFqdn This property is required. string
FQDN of SSH enabled interface on the device
SshKeys This property is required. []GetDeviceSecondaryDeviceSshKey
Definition of SSH key that will be provisioned on a device
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Uuid This property is required. string
UUID of an existing Equinix Network Edge device
VendorConfiguration This property is required. map[string]string
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
WanInterfaceId This property is required. string
device interface id picked for WAN
ZoneCode This property is required. string
Device location zone code
accountNumber This property is required. String
Device billing account number
aclTemplateId This property is required. String
Unique identifier of applied ACL template
additionalBandwidth This property is required. Integer
Additional Internet bandwidth, in Mbps, that will be allocated to the device
asn This property is required. Integer
Autonomous system number
cloudInitFileId This property is required. String
Unique identifier of applied cloud init file
hostname This property is required. String
Device hostname prefix
ibx This property is required. String
Device location Equinix Business Exchange name
interfaces This property is required. List<GetDeviceSecondaryDeviceInterface>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile This property is required. String
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
licenseFileId This property is required. String
Unique identifier of applied license file
licenseStatus This property is required. String
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken This property is required. String
License Token applicable for some device types in BYOL licensing mode
metroCode This property is required. String
Device location metro code
mgmtAclTemplateUuid This property is required. String
Unique identifier of applied MGMT ACL template
name This property is required. String
Name of an existing Equinix Network Edge device
notifications This property is required. List<String>
List of email addresses that will receive device status notifications
projectId This property is required. String
The unique identifier of Project Resource to which device is scoped to
redundancyType This property is required. String
Device redundancy type applicable for HA devices, either primary or secondary
redundantId This property is required. String
Unique identifier for a redundant device applicable for HA devices
region This property is required. String
Device location region
sshIpAddress This property is required. String
IP address of SSH enabled interface on the device
sshIpFqdn This property is required. String
FQDN of SSH enabled interface on the device
sshKeys This property is required. List<GetDeviceSecondaryDeviceSshKey>
Definition of SSH key that will be provisioned on a device
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfiguration This property is required. Map<String,String>
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
wanInterfaceId This property is required. String
device interface id picked for WAN
zoneCode This property is required. String
Device location zone code
accountNumber This property is required. string
Device billing account number
aclTemplateId This property is required. string
Unique identifier of applied ACL template
additionalBandwidth This property is required. number
Additional Internet bandwidth, in Mbps, that will be allocated to the device
asn This property is required. number
Autonomous system number
cloudInitFileId This property is required. string
Unique identifier of applied cloud init file
hostname This property is required. string
Device hostname prefix
ibx This property is required. string
Device location Equinix Business Exchange name
interfaces This property is required. GetDeviceSecondaryDeviceInterface[]
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile This property is required. string
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
licenseFileId This property is required. string
Unique identifier of applied license file
licenseStatus This property is required. string
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken This property is required. string
License Token applicable for some device types in BYOL licensing mode
metroCode This property is required. string
Device location metro code
mgmtAclTemplateUuid This property is required. string
Unique identifier of applied MGMT ACL template
name This property is required. string
Name of an existing Equinix Network Edge device
notifications This property is required. string[]
List of email addresses that will receive device status notifications
projectId This property is required. string
The unique identifier of Project Resource to which device is scoped to
redundancyType This property is required. string
Device redundancy type applicable for HA devices, either primary or secondary
redundantId This property is required. string
Unique identifier for a redundant device applicable for HA devices
region This property is required. string
Device location region
sshIpAddress This property is required. string
IP address of SSH enabled interface on the device
sshIpFqdn This property is required. string
FQDN of SSH enabled interface on the device
sshKeys This property is required. GetDeviceSecondaryDeviceSshKey[]
Definition of SSH key that will be provisioned on a device
status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
uuid This property is required. string
UUID of an existing Equinix Network Edge device
vendorConfiguration This property is required. {[key: string]: string}
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
wanInterfaceId This property is required. string
device interface id picked for WAN
zoneCode This property is required. string
Device location zone code
account_number This property is required. str
Device billing account number
acl_template_id This property is required. str
Unique identifier of applied ACL template
additional_bandwidth This property is required. int
Additional Internet bandwidth, in Mbps, that will be allocated to the device
asn This property is required. int
Autonomous system number
cloud_init_file_id This property is required. str
Unique identifier of applied cloud init file
hostname This property is required. str
Device hostname prefix
ibx This property is required. str
Device location Equinix Business Exchange name
interfaces This property is required. Sequence[GetDeviceSecondaryDeviceInterface]
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
license_file This property is required. str
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
license_file_id This property is required. str
Unique identifier of applied license file
license_status This property is required. str
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
license_token This property is required. str
License Token applicable for some device types in BYOL licensing mode
metro_code This property is required. str
Device location metro code
mgmt_acl_template_uuid This property is required. str
Unique identifier of applied MGMT ACL template
name This property is required. str
Name of an existing Equinix Network Edge device
notifications This property is required. Sequence[str]
List of email addresses that will receive device status notifications
project_id This property is required. str
The unique identifier of Project Resource to which device is scoped to
redundancy_type This property is required. str
Device redundancy type applicable for HA devices, either primary or secondary
redundant_id This property is required. str
Unique identifier for a redundant device applicable for HA devices
region This property is required. str
Device location region
ssh_ip_address This property is required. str
IP address of SSH enabled interface on the device
ssh_ip_fqdn This property is required. str
FQDN of SSH enabled interface on the device
ssh_keys This property is required. Sequence[GetDeviceSecondaryDeviceSshKey]
Definition of SSH key that will be provisioned on a device
status This property is required. str
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
uuid This property is required. str
UUID of an existing Equinix Network Edge device
vendor_configuration This property is required. Mapping[str, str]
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
wan_interface_id This property is required. str
device interface id picked for WAN
zone_code This property is required. str
Device location zone code
accountNumber This property is required. String
Device billing account number
aclTemplateId This property is required. String
Unique identifier of applied ACL template
additionalBandwidth This property is required. Number
Additional Internet bandwidth, in Mbps, that will be allocated to the device
asn This property is required. Number
Autonomous system number
cloudInitFileId This property is required. String
Unique identifier of applied cloud init file
hostname This property is required. String
Device hostname prefix
ibx This property is required. String
Device location Equinix Business Exchange name
interfaces This property is required. List<Property Map>
List of device interfaces

  • interface.#.id - interface identifier
  • interface.#.name - interface name
  • interface.#.status - interface status (AVAILABLE, RESERVED, ASSIGNED)
  • interface.#.operational_status - interface operational status (up or down)
  • interface.#.mac_address - interface MAC address
  • interface.#.ip_address - interface IP address
  • interface.#.assigned_type - interface management type (Equinix Managed or empty)
  • interface.#.type - interface type
licenseFile This property is required. String
Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
licenseFileId This property is required. String
Unique identifier of applied license file
licenseStatus This property is required. String
Device license registration status

  • APPLYING_LICENSE
  • REGISTERED
  • APPLIED
  • WAITING_FOR_CLUSTER_SETUP
  • REGISTRATION_FAILED
  • NA
licenseToken This property is required. String
License Token applicable for some device types in BYOL licensing mode
metroCode This property is required. String
Device location metro code
mgmtAclTemplateUuid This property is required. String
Unique identifier of applied MGMT ACL template
name This property is required. String
Name of an existing Equinix Network Edge device
notifications This property is required. List<String>
List of email addresses that will receive device status notifications
projectId This property is required. String
The unique identifier of Project Resource to which device is scoped to
redundancyType This property is required. String
Device redundancy type applicable for HA devices, either primary or secondary
redundantId This property is required. String
Unique identifier for a redundant device applicable for HA devices
region This property is required. String
Device location region
sshIpAddress This property is required. String
IP address of SSH enabled interface on the device
sshIpFqdn This property is required. String
FQDN of SSH enabled interface on the device
sshKeys This property is required. List<Property Map>
Definition of SSH key that will be provisioned on a device
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
uuid This property is required. String
UUID of an existing Equinix Network Edge device
vendorConfiguration This property is required. Map<String>
Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
wanInterfaceId This property is required. String
device interface id picked for WAN
zoneCode This property is required. String
Device location zone code

GetDeviceSecondaryDeviceInterface

AssignedType This property is required. string
Interface management type (Equinix Managed or empty)
Id This property is required. int
Interface identifier
IpAddress This property is required. string
interface IP address
MacAddress This property is required. string
Interface MAC addres
Name This property is required. string
Name of an existing Equinix Network Edge device
OperationalStatus This property is required. string
Interface operational status (up or down)
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Type This property is required. string
Interface type
AssignedType This property is required. string
Interface management type (Equinix Managed or empty)
Id This property is required. int
Interface identifier
IpAddress This property is required. string
interface IP address
MacAddress This property is required. string
Interface MAC addres
Name This property is required. string
Name of an existing Equinix Network Edge device
OperationalStatus This property is required. string
Interface operational status (up or down)
Status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
Type This property is required. string
Interface type
assignedType This property is required. String
Interface management type (Equinix Managed or empty)
id This property is required. Integer
Interface identifier
ipAddress This property is required. String
interface IP address
macAddress This property is required. String
Interface MAC addres
name This property is required. String
Name of an existing Equinix Network Edge device
operationalStatus This property is required. String
Interface operational status (up or down)
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. String
Interface type
assignedType This property is required. string
Interface management type (Equinix Managed or empty)
id This property is required. number
Interface identifier
ipAddress This property is required. string
interface IP address
macAddress This property is required. string
Interface MAC addres
name This property is required. string
Name of an existing Equinix Network Edge device
operationalStatus This property is required. string
Interface operational status (up or down)
status This property is required. string
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. string
Interface type
assigned_type This property is required. str
Interface management type (Equinix Managed or empty)
id This property is required. int
Interface identifier
ip_address This property is required. str
interface IP address
mac_address This property is required. str
Interface MAC addres
name This property is required. str
Name of an existing Equinix Network Edge device
operational_status This property is required. str
Interface operational status (up or down)
status This property is required. str
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. str
Interface type
assignedType This property is required. String
Interface management type (Equinix Managed or empty)
id This property is required. Number
Interface identifier
ipAddress This property is required. String
interface IP address
macAddress This property is required. String
Interface MAC addres
name This property is required. String
Name of an existing Equinix Network Edge device
operationalStatus This property is required. String
Interface operational status (up or down)
status This property is required. String
Device provisioning status

  • INITIALIZING
  • PROVISIONING
  • PROVISIONED (NOTE: By default data source will only return devices in this state. To include other states see valid_state_list)
  • WAITING_FOR_PRIMARY
  • WAITING_FOR_SECONDARY
  • WAITING_FOR_REPLICA_CLUSTER_NODES
  • CLUSTER_SETUP_IN_PROGRESS
  • FAILED
  • DEPROVISIONING
  • DEPROVISIONED
  • RESOURCE_UPGRADE_IN_PROGRESS
  • RESOURCE_UPGRADE_FAILED
type This property is required. String
Interface type

GetDeviceSecondaryDeviceSshKey

KeyName This property is required. string
Reference by name to previously provisioned public SSH key
Username This property is required. string
Username associated with given key
KeyName This property is required. string
Reference by name to previously provisioned public SSH key
Username This property is required. string
Username associated with given key
keyName This property is required. String
Reference by name to previously provisioned public SSH key
username This property is required. String
Username associated with given key
keyName This property is required. string
Reference by name to previously provisioned public SSH key
username This property is required. string
Username associated with given key
key_name This property is required. str
Reference by name to previously provisioned public SSH key
username This property is required. str
Username associated with given key
keyName This property is required. String
Reference by name to previously provisioned public SSH key
username This property is required. String
Username associated with given key

GetDeviceSshKey

KeyName This property is required. string
Reference by name to previously provisioned public SSH key
Username This property is required. string
Username associated with given key
KeyName This property is required. string
Reference by name to previously provisioned public SSH key
Username This property is required. string
Username associated with given key
keyName This property is required. String
Reference by name to previously provisioned public SSH key
username This property is required. String
Username associated with given key
keyName This property is required. string
Reference by name to previously provisioned public SSH key
username This property is required. string
Username associated with given key
key_name This property is required. str
Reference by name to previously provisioned public SSH key
username This property is required. str
Username associated with given key
keyName This property is required. String
Reference by name to previously provisioned public SSH key
username This property is required. String
Username associated with given key

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix