1. Packages
  2. Equinix
  3. API Docs
  4. networkedge
  5. getDevice
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix

equinix.networkedge.getDevice

Explore with Pulumi AI

equinix logo
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 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",
    });
    
    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")
    
    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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    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
    

    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>
    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]
    func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
    func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput

    > 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)
    }
    public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: equinix:networkedge/getDevice:getDevice
      arguments:
        # arguments dictionary

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

    GetDeviceClusterDetailNode0

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

    GetDeviceClusterDetailNode0VendorConfiguration

    ActivationKey string
    Activation key. This is required for Velocloud clusters
    AdminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    ControllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    Hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    RootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    ActivationKey string
    Activation key. This is required for Velocloud clusters
    AdminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    ControllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    Hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    RootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey String
    Activation key. This is required for Velocloud clusters
    adminPassword 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 String
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn String
    Controller fqdn. This is required for Velocloud clusters
    hostname String
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword String
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey string
    Activation key. This is required for Velocloud clusters
    adminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activation_key str
    Activation key. This is required for Velocloud clusters
    admin_password 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 str
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controller_fqdn str
    Controller fqdn. This is required for Velocloud clusters
    hostname str
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    root_password str
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey String
    Activation key. This is required for Velocloud clusters
    adminPassword 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 String
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn String
    Controller fqdn. This is required for Velocloud clusters
    hostname String
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword String
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster

    GetDeviceClusterDetailNode1

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

    GetDeviceClusterDetailNode1VendorConfiguration

    ActivationKey string
    Activation key. This is required for Velocloud clusters
    AdminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    ControllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    Hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    RootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    ActivationKey string
    Activation key. This is required for Velocloud clusters
    AdminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    ControllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    Hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    RootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey String
    Activation key. This is required for Velocloud clusters
    adminPassword 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 String
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn String
    Controller fqdn. This is required for Velocloud clusters
    hostname String
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword String
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey string
    Activation key. This is required for Velocloud clusters
    adminPassword 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 string
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn string
    Controller fqdn. This is required for Velocloud clusters
    hostname string
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword string
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activation_key str
    Activation key. This is required for Velocloud clusters
    admin_password 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 str
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controller_fqdn str
    Controller fqdn. This is required for Velocloud clusters
    hostname str
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    root_password str
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster
    activationKey String
    Activation key. This is required for Velocloud clusters
    adminPassword 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 String
    System IP Address. Mandatory for the Fortinet SDWAN cluster device
    controllerFqdn String
    Controller fqdn. This is required for Velocloud clusters
    hostname String
    Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters
    rootPassword String
    The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster

    GetDeviceInterface

    AssignedType string
    Interface management type (Equinix Managed or empty)
    Id int
    Interface identifier
    IpAddress string
    interface IP address
    MacAddress string
    Interface MAC addres
    Name string
    Name of an existing Equinix Network Edge device
    OperationalStatus string
    Interface operational status (up or down)
    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
    Type string
    Interface type
    AssignedType string
    Interface management type (Equinix Managed or empty)
    Id int
    Interface identifier
    IpAddress string
    interface IP address
    MacAddress string
    Interface MAC addres
    Name string
    Name of an existing Equinix Network Edge device
    OperationalStatus string
    Interface operational status (up or down)
    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
    Type string
    Interface type
    assignedType String
    Interface management type (Equinix Managed or empty)
    id Integer
    Interface identifier
    ipAddress String
    interface IP address
    macAddress String
    Interface MAC addres
    name String
    Name of an existing Equinix Network Edge device
    operationalStatus String
    Interface operational status (up or down)
    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
    type String
    Interface type
    assignedType string
    Interface management type (Equinix Managed or empty)
    id number
    Interface identifier
    ipAddress string
    interface IP address
    macAddress string
    Interface MAC addres
    name string
    Name of an existing Equinix Network Edge device
    operationalStatus string
    Interface operational status (up or down)
    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
    type string
    Interface type
    assigned_type str
    Interface management type (Equinix Managed or empty)
    id int
    Interface identifier
    ip_address str
    interface IP address
    mac_address str
    Interface MAC addres
    name str
    Name of an existing Equinix Network Edge device
    operational_status str
    Interface operational status (up or down)
    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
    type str
    Interface type
    assignedType String
    Interface management type (Equinix Managed or empty)
    id Number
    Interface identifier
    ipAddress String
    interface IP address
    macAddress String
    Interface MAC addres
    name String
    Name of an existing Equinix Network Edge device
    operationalStatus String
    Interface operational status (up or down)
    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
    type String
    Interface type

    GetDeviceSecondaryDevice

    AccountNumber string
    Device billing account number
    AclTemplateId string
    Unique identifier of applied ACL template
    AdditionalBandwidth int
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    Asn int
    Autonomous system number
    CloudInitFileId string
    Unique identifier of applied cloud init file
    Hostname string
    Device hostname prefix
    Ibx string
    Device location Equinix Business Exchange name
    Interfaces 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 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 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
    License Token applicable for some device types in BYOL licensing mode
    MetroCode string
    Device location metro code
    MgmtAclTemplateUuid string
    Unique identifier of applied MGMT ACL template
    Name string
    Name of an existing Equinix Network Edge device
    Notifications List<string>
    List of email addresses that will receive device status notifications
    ProjectId string
    The unique identifier of Project Resource to which device is scoped to
    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
    SshIpAddress string
    IP address of SSH enabled interface on the device
    SshIpFqdn string
    FQDN of SSH enabled interface on the device
    SshKeys List<GetDeviceSecondaryDeviceSshKey>
    Definition of SSH key that will be provisioned on a device
    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
    Uuid string
    UUID of an existing Equinix Network Edge device
    VendorConfiguration Dictionary<string, string>
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    WanInterfaceId string
    device interface id picked for WAN
    ZoneCode string
    Device location zone code
    AccountNumber string
    Device billing account number
    AclTemplateId string
    Unique identifier of applied ACL template
    AdditionalBandwidth int
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    Asn int
    Autonomous system number
    CloudInitFileId string
    Unique identifier of applied cloud init file
    Hostname string
    Device hostname prefix
    Ibx string
    Device location Equinix Business Exchange name
    Interfaces []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 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 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
    License Token applicable for some device types in BYOL licensing mode
    MetroCode string
    Device location metro code
    MgmtAclTemplateUuid string
    Unique identifier of applied MGMT ACL template
    Name string
    Name of an existing Equinix Network Edge device
    Notifications []string
    List of email addresses that will receive device status notifications
    ProjectId string
    The unique identifier of Project Resource to which device is scoped to
    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
    SshIpAddress string
    IP address of SSH enabled interface on the device
    SshIpFqdn string
    FQDN of SSH enabled interface on the device
    SshKeys []GetDeviceSecondaryDeviceSshKey
    Definition of SSH key that will be provisioned on a device
    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
    Uuid string
    UUID of an existing Equinix Network Edge device
    VendorConfiguration map[string]string
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    WanInterfaceId string
    device interface id picked for WAN
    ZoneCode string
    Device location zone code
    accountNumber String
    Device billing account number
    aclTemplateId String
    Unique identifier of applied ACL template
    additionalBandwidth Integer
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    asn Integer
    Autonomous system number
    cloudInitFileId String
    Unique identifier of applied cloud init file
    hostname String
    Device hostname prefix
    ibx String
    Device location Equinix Business Exchange name
    interfaces 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 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 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
    License Token applicable for some device types in BYOL licensing mode
    metroCode String
    Device location metro code
    mgmtAclTemplateUuid String
    Unique identifier of applied MGMT ACL template
    name String
    Name of an existing Equinix Network Edge device
    notifications List<String>
    List of email addresses that will receive device status notifications
    projectId String
    The unique identifier of Project Resource to which device is scoped to
    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
    sshIpAddress String
    IP address of SSH enabled interface on the device
    sshIpFqdn String
    FQDN of SSH enabled interface on the device
    sshKeys List<GetDeviceSecondaryDeviceSshKey>
    Definition of SSH key that will be provisioned on a device
    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
    uuid String
    UUID of an existing Equinix Network Edge device
    vendorConfiguration Map<String,String>
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    wanInterfaceId String
    device interface id picked for WAN
    zoneCode String
    Device location zone code
    accountNumber string
    Device billing account number
    aclTemplateId string
    Unique identifier of applied ACL template
    additionalBandwidth number
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    asn number
    Autonomous system number
    cloudInitFileId string
    Unique identifier of applied cloud init file
    hostname string
    Device hostname prefix
    ibx string
    Device location Equinix Business Exchange name
    interfaces 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 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 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
    License Token applicable for some device types in BYOL licensing mode
    metroCode string
    Device location metro code
    mgmtAclTemplateUuid string
    Unique identifier of applied MGMT ACL template
    name string
    Name of an existing Equinix Network Edge device
    notifications string[]
    List of email addresses that will receive device status notifications
    projectId string
    The unique identifier of Project Resource to which device is scoped to
    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
    sshIpAddress string
    IP address of SSH enabled interface on the device
    sshIpFqdn string
    FQDN of SSH enabled interface on the device
    sshKeys GetDeviceSecondaryDeviceSshKey[]
    Definition of SSH key that will be provisioned on a device
    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
    uuid string
    UUID of an existing Equinix Network Edge device
    vendorConfiguration {[key: string]: string}
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    wanInterfaceId string
    device interface id picked for WAN
    zoneCode string
    Device location zone code
    account_number str
    Device billing account number
    acl_template_id str
    Unique identifier of applied ACL template
    additional_bandwidth int
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    asn int
    Autonomous system number
    cloud_init_file_id str
    Unique identifier of applied cloud init file
    hostname str
    Device hostname prefix
    ibx str
    Device location Equinix Business Exchange name
    interfaces 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 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 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
    License Token applicable for some device types in BYOL licensing mode
    metro_code str
    Device location metro code
    mgmt_acl_template_uuid str
    Unique identifier of applied MGMT ACL template
    name str
    Name of an existing Equinix Network Edge device
    notifications Sequence[str]
    List of email addresses that will receive device status notifications
    project_id str
    The unique identifier of Project Resource to which device is scoped to
    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
    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[GetDeviceSecondaryDeviceSshKey]
    Definition of SSH key that will be provisioned on a device
    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
    uuid str
    UUID of an existing Equinix Network Edge device
    vendor_configuration Mapping[str, str]
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    wan_interface_id str
    device interface id picked for WAN
    zone_code str
    Device location zone code
    accountNumber String
    Device billing account number
    aclTemplateId String
    Unique identifier of applied ACL template
    additionalBandwidth Number
    Additional Internet bandwidth, in Mbps, that will be allocated to the device
    asn Number
    Autonomous system number
    cloudInitFileId String
    Unique identifier of applied cloud init file
    hostname String
    Device hostname prefix
    ibx String
    Device location Equinix Business Exchange name
    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
    Path to the license file that will be uploaded and applied on a device, applicable for some device types in BYOL licensing mode
    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
    License Token applicable for some device types in BYOL licensing mode
    metroCode String
    Device location metro code
    mgmtAclTemplateUuid String
    Unique identifier of applied MGMT ACL template
    name String
    Name of an existing Equinix Network Edge device
    notifications List<String>
    List of email addresses that will receive device status notifications
    projectId String
    The unique identifier of Project Resource to which device is scoped to
    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
    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>
    Definition of SSH key that will be provisioned on a device
    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
    uuid String
    UUID of an existing Equinix Network Edge device
    vendorConfiguration Map<String>
    Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)
    wanInterfaceId String
    device interface id picked for WAN
    zoneCode String
    Device location zone code

    GetDeviceSecondaryDeviceInterface

    AssignedType string
    Interface management type (Equinix Managed or empty)
    Id int
    Interface identifier
    IpAddress string
    interface IP address
    MacAddress string
    Interface MAC addres
    Name string
    Name of an existing Equinix Network Edge device
    OperationalStatus string
    Interface operational status (up or down)
    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
    Type string
    Interface type
    AssignedType string
    Interface management type (Equinix Managed or empty)
    Id int
    Interface identifier
    IpAddress string
    interface IP address
    MacAddress string
    Interface MAC addres
    Name string
    Name of an existing Equinix Network Edge device
    OperationalStatus string
    Interface operational status (up or down)
    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
    Type string
    Interface type
    assignedType String
    Interface management type (Equinix Managed or empty)
    id Integer
    Interface identifier
    ipAddress String
    interface IP address
    macAddress String
    Interface MAC addres
    name String
    Name of an existing Equinix Network Edge device
    operationalStatus String
    Interface operational status (up or down)
    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
    type String
    Interface type
    assignedType string
    Interface management type (Equinix Managed or empty)
    id number
    Interface identifier
    ipAddress string
    interface IP address
    macAddress string
    Interface MAC addres
    name string
    Name of an existing Equinix Network Edge device
    operationalStatus string
    Interface operational status (up or down)
    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
    type string
    Interface type
    assigned_type str
    Interface management type (Equinix Managed or empty)
    id int
    Interface identifier
    ip_address str
    interface IP address
    mac_address str
    Interface MAC addres
    name str
    Name of an existing Equinix Network Edge device
    operational_status str
    Interface operational status (up or down)
    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
    type str
    Interface type
    assignedType String
    Interface management type (Equinix Managed or empty)
    id Number
    Interface identifier
    ipAddress String
    interface IP address
    macAddress String
    Interface MAC addres
    name String
    Name of an existing Equinix Network Edge device
    operationalStatus String
    Interface operational status (up or down)
    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
    type String
    Interface type

    GetDeviceSecondaryDeviceSshKey

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

    GetDeviceSshKey

    KeyName string
    Reference by name to previously provisioned public SSH key
    Username string
    Username associated with given key
    KeyName string
    Reference by name to previously provisioned public SSH key
    Username string
    Username associated with given key
    keyName String
    Reference by name to previously provisioned public SSH key
    username String
    Username associated with given key
    keyName string
    Reference by name to previously provisioned public SSH key
    username string
    Username associated with given key
    key_name str
    Reference by name to previously provisioned public SSH key
    username str
    Username associated with given key
    keyName String
    Reference by name to previously provisioned public SSH key
    username 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 logo
    Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix