Docs Packages
  1. Pulumi Registry
  2. Equinix
  3. API Docs
  4. networkedge
  5. Device
equinix logo
Equinix v0.2.1, May 4 23

equinix.networkedge.Device

Explore with Pulumi AI

Example Usage

using System.Collections.Generic;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var accountName = config.Require("accountName");
    var licenseToken = config.Require("licenseToken");
    var sshUserName = config.Require("sshUserName");
    var sshKeyName = config.Require("sshKeyName");
    var aclTemplateId = config.Require("aclTemplateId");
    var metro = config.Get("metro") ?? "SV";
    var devicePackageCode = config.Get("devicePackageCode") ?? "network-essentials";
    var deviceVersion = config.Get("deviceVersion") ?? "17.06.01a";
    var sizeInCores = config.GetNumber("sizeInCores") ?? 2;
    var termLength = config.GetNumber("termLength") ?? 6;
    var additionalBandwidth = config.GetNumber("additionalBandwidth") ?? 5;
    var accountNum = Equinix.NetworkEdge.GetAccount.Invoke(new()
    {
        Name = accountName,
        MetroCode = metro,
    }).Apply(invoke => invoke.Number);

    var c8KRouter = new Equinix.NetworkEdge.Device("c8kRouter", new()
    {
        Name = "catalystRouter",
        MetroCode = metro,
        TypeCode = "C8000V",
        SelfManaged = true,
        Byol = true,
        PackageCode = devicePackageCode,
        Notifications = new[]
        {
            "example@equinix.com",
        },
        Hostname = "C8KV",
        AccountNumber = accountNum,
        Version = deviceVersion,
        CoreCount = sizeInCores,
        TermLength = termLength,
        LicenseToken = licenseToken,
        AdditionalBandwidth = additionalBandwidth,
        SshKey = new Equinix.NetworkEdge.Inputs.DeviceSshKeyArgs
        {
            Username = sshUserName,
            KeyName = sshKeyName,
        },
        AclTemplateId = aclTemplateId,
    });

    return new Dictionary<string, object?>
    {
        ["routerId"] = c8KRouter.Id,
        ["provisionStatus"] = c8KRouter.Status,
        ["licenseStatus"] = c8KRouter.LicenseStatus,
        ["sshIpAddress"] = c8KRouter.SshIpAddress,
    };
});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		accountName := cfg.Require("accountName")
		licenseToken := cfg.Require("licenseToken")
		sshUserName := cfg.Require("sshUserName")
		sshKeyName := cfg.Require("sshKeyName")
		aclTemplateId := cfg.Require("aclTemplateId")
		metro := "SV"
		if param := cfg.Get("metro"); param != "" {
			metro = param
		}
		devicePackageCode := "network-essentials"
		if param := cfg.Get("devicePackageCode"); param != "" {
			devicePackageCode = param
		}
		deviceVersion := "17.06.01a"
		if param := cfg.Get("deviceVersion"); param != "" {
			deviceVersion = param
		}
		sizeInCores := 2
		if param := cfg.GetInt("sizeInCores"); param != 0 {
			sizeInCores = param
		}
		termLength := 6
		if param := cfg.GetInt("termLength"); param != 0 {
			termLength = param
		}
		additionalBandwidth := 5
		if param := cfg.GetInt("additionalBandwidth"); param != 0 {
			additionalBandwidth = param
		}
		accountNum := networkedge.GetAccount(ctx, &networkedge.GetAccountArgs{
			Name:      pulumi.StringRef(accountName),
			MetroCode: metro,
		}, nil).Number
		c8KRouter, err := networkedge.NewDevice(ctx, "c8kRouter", &networkedge.DeviceArgs{
			Name:        pulumi.String("catalystRouter"),
			MetroCode:   pulumi.String(metro),
			TypeCode:    pulumi.String("C8000V"),
			SelfManaged: pulumi.Bool(true),
			Byol:        pulumi.Bool(true),
			PackageCode: pulumi.String(devicePackageCode),
			Notifications: pulumi.StringArray{
				pulumi.String("example@equinix.com"),
			},
			Hostname:            pulumi.String("C8KV"),
			AccountNumber:       *pulumi.String(accountNum),
			Version:             pulumi.Any(deviceVersion),
			CoreCount:           pulumi.Int(sizeInCores),
			TermLength:          pulumi.Int(termLength),
			LicenseToken:        pulumi.String(licenseToken),
			AdditionalBandwidth: pulumi.Int(additionalBandwidth),
			SshKey: &networkedge.DeviceSshKeyArgs{
				Username: pulumi.String(sshUserName),
				KeyName:  pulumi.String(sshKeyName),
			},
			AclTemplateId: pulumi.String(aclTemplateId),
		})
		if err != nil {
			return err
		}
		ctx.Export("routerId", c8KRouter.ID())
		ctx.Export("provisionStatus", c8KRouter.Status)
		ctx.Export("licenseStatus", c8KRouter.LicenseStatus)
		ctx.Export("sshIpAddress", c8KRouter.SshIpAddress)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.equinix.pulumi.networkedge.Device;
import com.equinix.pulumi.networkedge.DeviceArgs;
import com.equinix.pulumi.networkedge.inputs.DeviceSshKeyArgs;
import com.equinix.pulumi.networkedge.inputs.GetAccountArgs;
import com.equinix.pulumi.networkedge.NetworkedgeFunctions;
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 config = ctx.config();
        final var accountName = config.get("accountName").get();
        final var licenseToken = config.get("licenseToken").get();
        final var sshUserName = config.get("sshUserName").get();
        final var sshKeyName = config.get("sshKeyName").get();
        final var aclTemplateId = config.get("aclTemplateId").get();
        final var metro = config.get("metro").orElse("SV");
        final var devicePackageCode = config.get("devicePackageCode").orElse("network-essentials");
        final var deviceVersion = config.get("deviceVersion").orElse("17.06.01a");
        final var sizeInCores = Integer.parseInt(config.get("sizeInCores").orElse("2"));
        final var termLength = Integer.parseInt(config.get("termLength").orElse("6"));
        final var additionalBandwidth = Integer.parseInt(config.get("additionalBandwidth").orElse("5"));
        final var accountNum = NetworkedgeFunctions.getAccount(GetAccountArgs.builder()
            .name(accountName)
            .metroCode(metro)
            .build()).applyValue(account -> account.number());

        var c8KRouter = new Device("c8KRouter", DeviceArgs.builder()        
            .name("catalystRouter")
            .metroCode(metro)
            .typeCode("C8000V")
            .selfManaged(true)
            .byol(true)
            .packageCode(devicePackageCode)
            .notifications("example@equinix.com")
            .hostname("C8KV")
            .accountNumber(accountNum)
            .version(deviceVersion)
            .coreCount(sizeInCores)
            .termLength(termLength)
            .licenseToken(licenseToken)
            .additionalBandwidth(additionalBandwidth)
            .sshKey(DeviceSshKeyArgs.builder()
                .username(sshUserName)
                .keyName(sshKeyName)
                .build())
            .aclTemplateId(aclTemplateId)
            .build());

        ctx.export("routerId", c8KRouter.id());
        ctx.export("provisionStatus", c8KRouter.status());
        ctx.export("licenseStatus", c8KRouter.licenseStatus());
        ctx.export("sshIpAddress", c8KRouter.sshIpAddress());
    }
}

import pulumi
import pulumi_equinix as equinix

config = pulumi.Config()
account_name = config.require("accountName")
license_token = config.require("licenseToken")
ssh_user_name = config.require("sshUserName")
ssh_key_name = config.require("sshKeyName")
acl_template_id = config.require("aclTemplateId")
metro = config.get("metro")
if metro is None:
    metro = "SV"
device_package_code = config.get("devicePackageCode")
if device_package_code is None:
    device_package_code = "network-essentials"
device_version = config.get("deviceVersion")
if device_version is None:
    device_version = "17.06.01a"
size_in_cores = config.get_int("sizeInCores")
if size_in_cores is None:
    size_in_cores = 2
term_length = config.get_int("termLength")
if term_length is None:
    term_length = 6
additional_bandwidth = config.get_int("additionalBandwidth")
if additional_bandwidth is None:
    additional_bandwidth = 5
account_num = equinix.networkedge.get_account(name=account_name,
    metro_code=metro).number
c8_k_router = equinix.networkedge.Device("c8kRouter",
    name="catalystRouter",
    metro_code=metro,
    type_code="C8000V",
    self_managed=True,
    byol=True,
    package_code=device_package_code,
    notifications=["example@equinix.com"],
    hostname="C8KV",
    account_number=account_num,
    version=device_version,
    core_count=size_in_cores,
    term_length=term_length,
    license_token=license_token,
    additional_bandwidth=additional_bandwidth,
    ssh_key=equinix.networkedge.DeviceSshKeyArgs(
        username=ssh_user_name,
        key_name=ssh_key_name,
    ),
    acl_template_id=acl_template_id)
pulumi.export("routerId", c8_k_router.id)
pulumi.export("provisionStatus", c8_k_router.status)
pulumi.export("licenseStatus", c8_k_router.license_status)
pulumi.export("sshIpAddress", c8_k_router.ssh_ip_address)

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

const config = new pulumi.Config();
const accountName = config.require("accountName");
const licenseToken = config.require("licenseToken");
const sshUserName = config.require("sshUserName");
const sshKeyName = config.require("sshKeyName");
const aclTemplateId = config.require("aclTemplateId");
const metro = config.get("metro") || "SV";
const devicePackageCode = config.get("devicePackageCode") || "network-essentials";
const deviceVersion = config.get("deviceVersion") || "17.06.01a";
const sizeInCores = config.getNumber("sizeInCores") || 2;
const termLength = config.getNumber("termLength") || 6;
const additionalBandwidth = config.getNumber("additionalBandwidth") || 5;
const accountNum = equinix.networkedge.getAccount({
    name: accountName,
    metroCode: metro,
}).then(invoke => invoke.number);
const c8KRouter = new equinix.networkedge.Device("c8kRouter", {
    name: "catalystRouter",
    metroCode: metro,
    typeCode: "C8000V",
    selfManaged: true,
    byol: true,
    packageCode: devicePackageCode,
    notifications: ["example@equinix.com"],
    hostname: "C8KV",
    accountNumber: accountNum,
    version: deviceVersion,
    coreCount: sizeInCores,
    termLength: termLength,
    licenseToken: licenseToken,
    additionalBandwidth: additionalBandwidth,
    sshKey: {
        username: sshUserName,
        keyName: sshKeyName,
    },
    aclTemplateId: aclTemplateId,
});
export const routerId = c8KRouter.id;
export const provisionStatus = c8KRouter.status;
export const licenseStatus = c8KRouter.licenseStatus;
export const sshIpAddress = c8KRouter.sshIpAddress;

config:
  accountName:
    type: string
  licenseToken:
    type: string
  sshUserName:
    type: string
  sshKeyName:
    type: string
  aclTemplateId:
    type: string
  metro:
    type: string
    default: SV
  devicePackageCode:
    type: string
    default: network-essentials
  deviceVersion:
    type: string
    default: 17.06.01a
  sizeInCores:
    type: integer
    default: 2
  termLength:
    type: integer
    default: 6
  additionalBandwidth:
    type: integer
    default: 5
variables:
  accountNum:
    fn::invoke:
      function: equinix:networkedge:getAccount
      arguments:
        name: ${accountName}
        metroCode: ${metro}
      return: number
resources:
  c8kRouter:
    type: equinix:networkedge:Device
    properties:
      name: catalystRouter
      metroCode: ${metro}
      typeCode: C8000V
      selfManaged: true
      byol: true
      packageCode: ${devicePackageCode}
      notifications:
      - "example@equinix.com"
      hostname: C8KV
      accountNumber: ${accountNum}
      version: ${deviceVersion}
      coreCount: ${sizeInCores}
      termLength: ${termLength}
      licenseToken: ${licenseToken}
      additionalBandwidth: ${additionalBandwidth}
      sshKey:
        username: ${sshUserName}
        keyName: ${sshKeyName}
      aclTemplateId: ${aclTemplateId}
outputs:
  routerId: ${c8kRouter.id}
  provisionStatus: ${c8kRouter.status}
  licenseStatus: ${c8kRouter.licenseStatus}
  sshIpAddress: ${c8kRouter.sshIpAddress}

Create Device Resource

new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account_number: Optional[str] = None,
           acl_template_id: Optional[str] = None,
           additional_bandwidth: Optional[int] = None,
           byol: Optional[bool] = None,
           cloud_init_file_id: Optional[str] = None,
           cluster_details: Optional[DeviceClusterDetailsArgs] = None,
           core_count: Optional[int] = None,
           hostname: Optional[str] = None,
           interface_count: Optional[int] = None,
           license_file: Optional[str] = None,
           license_file_id: Optional[str] = None,
           license_token: Optional[str] = None,
           metro_code: Optional[str] = None,
           mgmt_acl_template_uuid: Optional[str] = None,
           name: Optional[str] = None,
           notifications: Optional[Sequence[str]] = None,
           order_reference: Optional[str] = None,
           package_code: Optional[str] = None,
           purchase_order_number: Optional[str] = None,
           secondary_device: Optional[DeviceSecondaryDeviceArgs] = None,
           self_managed: Optional[bool] = None,
           ssh_key: Optional[DeviceSshKeyArgs] = None,
           term_length: Optional[int] = None,
           throughput: Optional[int] = None,
           throughput_unit: Optional[Union[str, ThroughputUnit]] = None,
           type_code: Optional[str] = None,
           vendor_configuration: Optional[Mapping[str, str]] = None,
           version: Optional[str] = None,
           wan_interface_id: Optional[str] = None)
@overload
def Device(resource_name: str,
           args: DeviceArgs,
           opts: Optional[ResourceOptions] = None)
func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)

type: equinix:networkedge:Device
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeviceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Device Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Device resource accepts the following input properties:

AccountNumber string

Billing account number for a device.

CoreCount int

Number of CPU cores used by device.

MetroCode string

Device location metro code.

Notifications List<string>

List of email addresses that will receive device status notifications.

PackageCode string

Device software package code.

TermLength int

Device term length.

TypeCode string

Device type code.

Version string

Device software software version.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

Byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

CloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

ClusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

Hostname string

Device hostname prefix.

InterfaceCount int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

Name string

Device name.

OrderReference string

Name/number used to identify device order on the invoice.

PurchaseOrderNumber string

Purchase order number associated with a device order.

SecondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

SelfManaged bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

SshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

Throughput int

Device license throughput.

ThroughputUnit string | Pulumi.Equinix.NetworkEdge.ThroughputUnit

License throughput unit. One of Mbps or Gbps.

VendorConfiguration Dictionary<string, string>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
WanInterfaceId string

device interface id picked for WAN

AccountNumber string

Billing account number for a device.

CoreCount int

Number of CPU cores used by device.

MetroCode string

Device location metro code.

Notifications []string

List of email addresses that will receive device status notifications.

PackageCode string

Device software package code.

TermLength int

Device term length.

TypeCode string

Device type code.

Version string

Device software software version.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

Byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

CloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

ClusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

Hostname string

Device hostname prefix.

InterfaceCount int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

Name string

Device name.

OrderReference string

Name/number used to identify device order on the invoice.

PurchaseOrderNumber string

Purchase order number associated with a device order.

SecondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

SelfManaged bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

SshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

Throughput int

Device license throughput.

ThroughputUnit string | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

VendorConfiguration map[string]string

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
WanInterfaceId string

device interface id picked for WAN

accountNumber String

Billing account number for a device.

coreCount Integer

Number of CPU cores used by device.

metroCode String

Device location metro code.

notifications List<String>

List of email addresses that will receive device status notifications.

packageCode String

Device software package code.

termLength Integer

Device term length.

typeCode String

Device type code.

version String

Device software software version.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth Integer

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

byol Boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId String

Identifier of a cloud init file that will be applied on the device.

clusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

hostname String

Device hostname prefix.

interfaceCount Integer

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on the device.

name String

Device name.

orderReference String

Name/number used to identify device order on the invoice.

purchaseOrderNumber String

Purchase order number associated with a device order.

secondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged Boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

throughput Integer

Device license throughput.

throughputUnit String | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

vendorConfiguration Map<String,String>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
wanInterfaceId String

device interface id picked for WAN

accountNumber string

Billing account number for a device.

coreCount number

Number of CPU cores used by device.

metroCode string

Device location metro code.

notifications string[]

List of email addresses that will receive device status notifications.

packageCode string

Device software package code.

termLength number

Device term length.

typeCode string

Device type code.

version string

Device software software version.

aclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth number

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

byol boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

clusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

hostname string

Device hostname prefix.

interfaceCount number

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

licenseToken string

License Token applicable for some device types in BYOL licensing mode.

mgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

name string

Device name.

orderReference string

Name/number used to identify device order on the invoice.

purchaseOrderNumber string

Purchase order number associated with a device order.

secondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

throughput number

Device license throughput.

throughputUnit string | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

vendorConfiguration {[key: string]: string}

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
wanInterfaceId string

device interface id picked for WAN

account_number str

Billing account number for a device.

core_count int

Number of CPU cores used by device.

metro_code str

Device location metro code.

notifications Sequence[str]

List of email addresses that will receive device status notifications.

package_code str

Device software package code.

term_length int

Device term length.

type_code str

Device type code.

version str

Device software software version.

acl_template_id str

Identifier of a WAN interface ACL template that will be applied on the device.

additional_bandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloud_init_file_id str

Identifier of a cloud init file that will be applied on the device.

cluster_details DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

hostname str

Device hostname prefix.

interface_count int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

license_token str

License Token applicable for some device types in BYOL licensing mode.

mgmt_acl_template_uuid str

Identifier of an MGMT interface ACL template that will be applied on the device.

name str

Device name.

order_reference str

Name/number used to identify device order on the invoice.

purchase_order_number str

Purchase order number associated with a device order.

secondary_device DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

self_managed bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

ssh_key DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

throughput int

Device license throughput.

throughput_unit str | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

vendor_configuration Mapping[str, str]

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
wan_interface_id str

device interface id picked for WAN

accountNumber String

Billing account number for a device.

coreCount Number

Number of CPU cores used by device.

metroCode String

Device location metro code.

notifications List<String>

List of email addresses that will receive device status notifications.

packageCode String

Device software package code.

termLength Number

Device term length.

typeCode String

Device type code.

version String

Device software software version.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth Number

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

byol Boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId String

Identifier of a cloud init file that will be applied on the device.

clusterDetails Property Map

An object that has the cluster details. See Cluster Details below for more details.

hostname String

Device hostname prefix.

interfaceCount Number

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

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

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on the device.

name String

Device name.

orderReference String

Name/number used to identify device order on the invoice.

purchaseOrderNumber String

Purchase order number associated with a device order.

secondaryDevice Property Map

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged Boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshKey Property Map

Definition of SSH key that will be provisioned on a device

throughput Number

Device license throughput.

throughputUnit String | "Mbps" | "Gbps"

License throughput unit. One of Mbps or Gbps.

vendorConfiguration Map<String>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
wanInterfaceId String

device interface id picked for WAN

Outputs

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

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

Ibx string

Device location Equinix Business Exchange name.

Id string

The provider-assigned unique ID for this managed resource.

Interfaces List<DeviceInterface>

List of device interfaces. See Interface Attribute below for more details.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

Uuid string

Device unique identifier.

ZoneCode string

Device location zone code.

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

Ibx string

Device location Equinix Business Exchange name.

Id string

The provider-assigned unique ID for this managed resource.

Interfaces []DeviceInterface

List of device interfaces. See Interface Attribute below for more details.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

Uuid string

Device unique identifier.

ZoneCode string

Device location zone code.

asn Integer

(Autonomous System Number) Unique identifier for a network on the internet.

ibx String

Device location Equinix Business Exchange name.

id String

The provider-assigned unique ID for this managed resource.

interfaces List<DeviceInterface>

List of device interfaces. See Interface Attribute below for more details.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid String

Device unique identifier.

zoneCode String

Device location zone code.

asn number

(Autonomous System Number) Unique identifier for a network on the internet.

ibx string

Device location Equinix Business Exchange name.

id string

The provider-assigned unique ID for this managed resource.

interfaces DeviceInterface[]

List of device interfaces. See Interface Attribute below for more details.

licenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid string

Device unique identifier.

zoneCode string

Device location zone code.

asn int

(Autonomous System Number) Unique identifier for a network on the internet.

ibx str

Device location Equinix Business Exchange name.

id str

The provider-assigned unique ID for this managed resource.

interfaces Sequence[DeviceInterface]

List of device interfaces. See Interface Attribute below for more details.

license_status str

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

status str

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid str

Device unique identifier.

zone_code str

Device location zone code.

asn Number

(Autonomous System Number) Unique identifier for a network on the internet.

ibx String

Device location Equinix Business Exchange name.

id String

The provider-assigned unique ID for this managed resource.

interfaces List<Property Map>

List of device interfaces. See Interface Attribute below for more details.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid String

Device unique identifier.

zoneCode String

Device location zone code.

Look up Existing Device Resource

Get an existing Device resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeviceState, opts?: CustomResourceOptions): Device
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_number: Optional[str] = None,
        acl_template_id: Optional[str] = None,
        additional_bandwidth: Optional[int] = None,
        asn: Optional[int] = None,
        byol: Optional[bool] = None,
        cloud_init_file_id: Optional[str] = None,
        cluster_details: Optional[DeviceClusterDetailsArgs] = None,
        core_count: Optional[int] = None,
        hostname: Optional[str] = None,
        ibx: Optional[str] = None,
        interface_count: Optional[int] = None,
        interfaces: Optional[Sequence[DeviceInterfaceArgs]] = None,
        license_file: Optional[str] = None,
        license_file_id: Optional[str] = None,
        license_status: Optional[str] = None,
        license_token: Optional[str] = None,
        metro_code: Optional[str] = None,
        mgmt_acl_template_uuid: Optional[str] = None,
        name: Optional[str] = None,
        notifications: Optional[Sequence[str]] = None,
        order_reference: Optional[str] = None,
        package_code: Optional[str] = None,
        purchase_order_number: Optional[str] = None,
        redundancy_type: Optional[str] = None,
        redundant_id: Optional[str] = None,
        region: Optional[str] = None,
        secondary_device: Optional[DeviceSecondaryDeviceArgs] = None,
        self_managed: Optional[bool] = None,
        ssh_ip_address: Optional[str] = None,
        ssh_ip_fqdn: Optional[str] = None,
        ssh_key: Optional[DeviceSshKeyArgs] = None,
        status: Optional[str] = None,
        term_length: Optional[int] = None,
        throughput: Optional[int] = None,
        throughput_unit: Optional[Union[str, ThroughputUnit]] = None,
        type_code: Optional[str] = None,
        uuid: Optional[str] = None,
        vendor_configuration: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None,
        wan_interface_id: Optional[str] = None,
        zone_code: Optional[str] = None) -> Device
func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountNumber string

Billing account number for a device.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

Byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

CloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

ClusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

CoreCount int

Number of CPU cores used by device.

Hostname string

Device hostname prefix.

Ibx string

Device location Equinix Business Exchange name.

InterfaceCount int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

Interfaces List<DeviceInterfaceArgs>

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

MetroCode string

Device location metro code.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

Name string

Device name.

Notifications List<string>

List of email addresses that will receive device status notifications.

OrderReference string

Name/number used to identify device order on the invoice.

PackageCode string

Device software package code.

PurchaseOrderNumber string

Purchase order number associated with a device order.

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.

SecondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

SelfManaged bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

SshIpAddress string

IP address of SSH enabled interface on the device.

SshIpFqdn string

FQDN of SSH enabled interface on the device.

SshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

TermLength int

Device term length.

Throughput int

Device license throughput.

ThroughputUnit string | Pulumi.Equinix.NetworkEdge.ThroughputUnit

License throughput unit. One of Mbps or Gbps.

TypeCode string

Device type code.

Uuid string

Device unique identifier.

VendorConfiguration Dictionary<string, string>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
Version string

Device software software version.

WanInterfaceId string

device interface id picked for WAN

ZoneCode string

Device location zone code.

AccountNumber string

Billing account number for a device.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

Byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

CloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

ClusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

CoreCount int

Number of CPU cores used by device.

Hostname string

Device hostname prefix.

Ibx string

Device location Equinix Business Exchange name.

InterfaceCount int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

Interfaces []DeviceInterfaceArgs

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

MetroCode string

Device location metro code.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

Name string

Device name.

Notifications []string

List of email addresses that will receive device status notifications.

OrderReference string

Name/number used to identify device order on the invoice.

PackageCode string

Device software package code.

PurchaseOrderNumber string

Purchase order number associated with a device order.

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.

SecondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

SelfManaged bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

SshIpAddress string

IP address of SSH enabled interface on the device.

SshIpFqdn string

FQDN of SSH enabled interface on the device.

SshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

TermLength int

Device term length.

Throughput int

Device license throughput.

ThroughputUnit string | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

TypeCode string

Device type code.

Uuid string

Device unique identifier.

VendorConfiguration map[string]string

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
Version string

Device software software version.

WanInterfaceId string

device interface id picked for WAN

ZoneCode string

Device location zone code.

accountNumber String

Billing account number for a device.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth Integer

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

asn Integer

(Autonomous System Number) Unique identifier for a network on the internet.

byol Boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId String

Identifier of a cloud init file that will be applied on the device.

clusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

coreCount Integer

Number of CPU cores used by device.

hostname String

Device hostname prefix.

ibx String

Device location Equinix Business Exchange name.

interfaceCount Integer

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

interfaces List<DeviceInterfaceArgs>

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

metroCode String

Device location metro code.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on the device.

name String

Device name.

notifications List<String>

List of email addresses that will receive device status notifications.

orderReference String

Name/number used to identify device order on the invoice.

packageCode String

Device software package code.

purchaseOrderNumber String

Purchase order number associated with a device order.

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.

secondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged Boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshIpAddress String

IP address of SSH enabled interface on the device.

sshIpFqdn String

FQDN of SSH enabled interface on the device.

sshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

termLength Integer

Device term length.

throughput Integer

Device license throughput.

throughputUnit String | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

typeCode String

Device type code.

uuid String

Device unique identifier.

vendorConfiguration Map<String,String>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
version String

Device software software version.

wanInterfaceId String

device interface id picked for WAN

zoneCode String

Device location zone code.

accountNumber string

Billing account number for a device.

aclTemplateId string

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth number

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

asn number

(Autonomous System Number) Unique identifier for a network on the internet.

byol boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId string

Identifier of a cloud init file that will be applied on the device.

clusterDetails DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

coreCount number

Number of CPU cores used by device.

hostname string

Device hostname prefix.

ibx string

Device location Equinix Business Exchange name.

interfaceCount number

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

interfaces DeviceInterfaceArgs[]

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

licenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken string

License Token applicable for some device types in BYOL licensing mode.

metroCode string

Device location metro code.

mgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on the device.

name string

Device name.

notifications string[]

List of email addresses that will receive device status notifications.

orderReference string

Name/number used to identify device order on the invoice.

packageCode string

Device software package code.

purchaseOrderNumber string

Purchase order number associated with a device order.

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.

secondaryDevice DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshIpAddress string

IP address of SSH enabled interface on the device.

sshIpFqdn string

FQDN of SSH enabled interface on the device.

sshKey DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

termLength number

Device term length.

throughput number

Device license throughput.

throughputUnit string | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

typeCode string

Device type code.

uuid string

Device unique identifier.

vendorConfiguration {[key: string]: string}

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
version string

Device software software version.

wanInterfaceId string

device interface id picked for WAN

zoneCode string

Device location zone code.

account_number str

Billing account number for a device.

acl_template_id str

Identifier of a WAN interface ACL template that will be applied on the device.

additional_bandwidth int

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

asn int

(Autonomous System Number) Unique identifier for a network on the internet.

byol bool

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloud_init_file_id str

Identifier of a cloud init file that will be applied on the device.

cluster_details DeviceClusterDetailsArgs

An object that has the cluster details. See Cluster Details below for more details.

core_count int

Number of CPU cores used by device.

hostname str

Device hostname prefix.

ibx str

Device location Equinix Business Exchange name.

interface_count int

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

interfaces Sequence[DeviceInterfaceArgs]

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

license_status str

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

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

Identifier of an MGMT interface ACL template that will be applied on the device.

name str

Device name.

notifications Sequence[str]

List of email addresses that will receive device status notifications.

order_reference str

Name/number used to identify device order on the invoice.

package_code str

Device software package code.

purchase_order_number str

Purchase order number associated with a device order.

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_device DeviceSecondaryDeviceArgs

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

self_managed bool

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

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_key DeviceSshKeyArgs

Definition of SSH key that will be provisioned on a device

status str

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

term_length int

Device term length.

throughput int

Device license throughput.

throughput_unit str | ThroughputUnit

License throughput unit. One of Mbps or Gbps.

type_code str

Device type code.

uuid str

Device unique identifier.

vendor_configuration Mapping[str, str]

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
version str

Device software software version.

wan_interface_id str

device interface id picked for WAN

zone_code str

Device location zone code.

accountNumber String

Billing account number for a device.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on the device.

additionalBandwidth Number

Additional Internet bandwidth, in Mbps, that will be allocated to the device (in addition to default 15Mbps).

asn Number

(Autonomous System Number) Unique identifier for a network on the internet.

byol Boolean

Boolean value that determines device licensing mode, i.e., bring your own license or subscription (default).

cloudInitFileId String

Identifier of a cloud init file that will be applied on the device.

clusterDetails Property Map

An object that has the cluster details. See Cluster Details below for more details.

coreCount Number

Number of CPU cores used by device.

hostname String

Device hostname prefix.

ibx String

Device location Equinix Business Exchange name.

interfaceCount Number

Number of network interfaces on a device. If not specified, default number for a given device type will be used.

interfaces List<Property Map>

List of device interfaces. See Interface Attribute below for more details.

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

Identifier of a license file that will be applied on the device.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

metroCode String

Device location metro code.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on the device.

name String

Device name.

notifications List<String>

List of email addresses that will receive device status notifications.

orderReference String

Name/number used to identify device order on the invoice.

packageCode String

Device software package code.

purchaseOrderNumber String

Purchase order number associated with a device order.

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.

secondaryDevice Property Map

Definition of secondary device for redundant device configurations. See Secondary Device below for more details.

selfManaged Boolean

Boolean value that determines device management mode, i.e., self-managed or Equinix-managed (default).

sshIpAddress String

IP address of SSH enabled interface on the device.

sshIpFqdn String

FQDN of SSH enabled interface on the device.

sshKey Property Map

Definition of SSH key that will be provisioned on a device

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

termLength Number

Device term length.

throughput Number

Device license throughput.

throughputUnit String | "Mbps" | "Gbps"

License throughput unit. One of Mbps or Gbps.

typeCode String

Device type code.

uuid String

Device unique identifier.

vendorConfiguration Map<String>

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
version String

Device software software version.

wanInterfaceId String

device interface id picked for WAN

zoneCode String

Device location zone code.

Supporting Types

DeviceClusterDetails

ClusterName string

The name of the cluster device

Node0 DeviceClusterDetailsNode0

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

Node1 DeviceClusterDetailsNode1

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

ClusterId string

The ID of the cluster.

NumOfNodes int

The number of nodes in the cluster.

ClusterName string

The name of the cluster device

Node0 DeviceClusterDetailsNode0

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

Node1 DeviceClusterDetailsNode1

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

ClusterId string

The ID of the cluster.

NumOfNodes int

The number of nodes in the cluster.

clusterName String

The name of the cluster device

node0 DeviceClusterDetailsNode0

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

node1 DeviceClusterDetailsNode1

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

clusterId String

The ID of the cluster.

numOfNodes Integer

The number of nodes in the cluster.

clusterName string

The name of the cluster device

node0 DeviceClusterDetailsNode0

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

node1 DeviceClusterDetailsNode1

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

clusterId string

The ID of the cluster.

numOfNodes number

The number of nodes in the cluster.

cluster_name str

The name of the cluster device

node0 DeviceClusterDetailsNode0

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

node1 DeviceClusterDetailsNode1

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

cluster_id str

The ID of the cluster.

num_of_nodes int

The number of nodes in the cluster.

clusterName String

The name of the cluster device

node0 Property Map

An object that has node0 configuration. See Cluster Details - Nodes below for more details.

node1 Property Map

An object that has node1 configuration. See Cluster Details - Nodes below for more details.

clusterId String

The ID of the cluster.

numOfNodes Number

The number of nodes in the cluster.

DeviceClusterDetailsNode0

LicenseFileId string

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

Name string

Device name.

Uuid string

Device unique identifier.

VendorConfiguration DeviceClusterDetailsNode0VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
LicenseFileId string

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

Name string

Device name.

Uuid string

Device unique identifier.

VendorConfiguration DeviceClusterDetailsNode0VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId String

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

name String

Device name.

uuid String

Device unique identifier.

vendorConfiguration DeviceClusterDetailsNode0VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId string

Identifier of a license file that will be applied on the device.

licenseToken string

License Token applicable for some device types in BYOL licensing mode.

name string

Device name.

uuid string

Device unique identifier.

vendorConfiguration DeviceClusterDetailsNode0VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
license_file_id str

Identifier of a license file that will be applied on the device.

license_token str

License Token applicable for some device types in BYOL licensing mode.

name str

Device name.

uuid str

Device unique identifier.

vendor_configuration DeviceClusterDetailsNode0VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId String

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

name String

Device name.

uuid String

Device unique identifier.

vendorConfiguration Property Map

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.

DeviceClusterDetailsNode0VendorConfiguration

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.

DeviceClusterDetailsNode1

LicenseFileId string

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

Name string

Device name.

Uuid string

Device unique identifier.

VendorConfiguration DeviceClusterDetailsNode1VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
LicenseFileId string

Identifier of a license file that will be applied on the device.

LicenseToken string

License Token applicable for some device types in BYOL licensing mode.

Name string

Device name.

Uuid string

Device unique identifier.

VendorConfiguration DeviceClusterDetailsNode1VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId String

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

name String

Device name.

uuid String

Device unique identifier.

vendorConfiguration DeviceClusterDetailsNode1VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId string

Identifier of a license file that will be applied on the device.

licenseToken string

License Token applicable for some device types in BYOL licensing mode.

name string

Device name.

uuid string

Device unique identifier.

vendorConfiguration DeviceClusterDetailsNode1VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
license_file_id str

Identifier of a license file that will be applied on the device.

license_token str

License Token applicable for some device types in BYOL licensing mode.

name str

Device name.

uuid str

Device unique identifier.

vendor_configuration DeviceClusterDetailsNode1VendorConfiguration

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.
licenseFileId String

Identifier of a license file that will be applied on the device.

licenseToken String

License Token applicable for some device types in BYOL licensing mode.

name String

Device name.

uuid String

Device unique identifier.

vendorConfiguration Property Map

Map of vendor specific configuration parameters for a device (controller1, activationKey, managementType, siteId, systemIpAddress)

  • ssh-key - (Optional) Definition of SSH key that will be provisioned on a device (max one key). See SSH Key below for more details.

DeviceClusterDetailsNode1VendorConfiguration

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.

DeviceInterface

AssignedType string

interface management type (Equinix Managed or empty).

Id int

interface identifier.

IpAddress string

interface IP address.

MacAddress string

interface MAC address.

Name string

Device name.

OperationalStatus string

interface operational status. One of up, down.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

Name string

Device name.

OperationalStatus string

interface operational status. One of up, down.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name String

Device name.

operationalStatus String

interface operational status. One of up, down.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name string

Device name.

operationalStatus string

interface operational status. One of up, down.

status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name str

Device name.

operational_status str

interface operational status. One of up, down.

status str

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name String

Device name.

operationalStatus String

interface operational status. One of up, down.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

type String

interface type.

DeviceSecondaryDevice

AccountNumber string

Billing account number for secondary device.

MetroCode string

Metro location of a secondary device.

Name string

Secondary device name.

Notifications List<string>

List of email addresses that will receive notifications about secondary device.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on a secondary device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, for a secondary device.

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

CloudInitFileId string

Identifier of a cloud init file that will be applied on a secondary device.

Hostname string

Secondary device hostname.

Ibx string

Device location Equinix Business Exchange name.

Interfaces List<DeviceSecondaryDeviceInterface>

List of device interfaces. See Interface Attribute below for more details.

LicenseFile string

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

LicenseFileId string

Identifier of a license file that will be applied on a secondary device.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

LicenseToken string

License Token can be provided for some device types o the device.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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.

SshKey DeviceSecondaryDeviceSshKey
Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

Uuid string

Device unique identifier.

VendorConfiguration Dictionary<string, string>

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

WanInterfaceId string
ZoneCode string

Device location zone code.

AccountNumber string

Billing account number for secondary device.

MetroCode string

Metro location of a secondary device.

Name string

Secondary device name.

Notifications []string

List of email addresses that will receive notifications about secondary device.

AclTemplateId string

Identifier of a WAN interface ACL template that will be applied on a secondary device.

AdditionalBandwidth int

Additional Internet bandwidth, in Mbps, for a secondary device.

Asn int

(Autonomous System Number) Unique identifier for a network on the internet.

CloudInitFileId string

Identifier of a cloud init file that will be applied on a secondary device.

Hostname string

Secondary device hostname.

Ibx string

Device location Equinix Business Exchange name.

Interfaces []DeviceSecondaryDeviceInterface

List of device interfaces. See Interface Attribute below for more details.

LicenseFile string

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

LicenseFileId string

Identifier of a license file that will be applied on a secondary device.

LicenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

LicenseToken string

License Token can be provided for some device types o the device.

MgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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.

SshKey DeviceSecondaryDeviceSshKey
Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

Uuid string

Device unique identifier.

VendorConfiguration map[string]string

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

WanInterfaceId string
ZoneCode string

Device location zone code.

accountNumber String

Billing account number for secondary device.

metroCode String

Metro location of a secondary device.

name String

Secondary device name.

notifications List<String>

List of email addresses that will receive notifications about secondary device.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on a secondary device.

additionalBandwidth Integer

Additional Internet bandwidth, in Mbps, for a secondary device.

asn Integer

(Autonomous System Number) Unique identifier for a network on the internet.

cloudInitFileId String

Identifier of a cloud init file that will be applied on a secondary device.

hostname String

Secondary device hostname.

ibx String

Device location Equinix Business Exchange name.

interfaces List<DeviceSecondaryDeviceInterface>

List of device interfaces. See Interface Attribute below for more details.

licenseFile String

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

licenseFileId String

Identifier of a license file that will be applied on a secondary device.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken String

License Token can be provided for some device types o the device.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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.

sshKey DeviceSecondaryDeviceSshKey
status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid String

Device unique identifier.

vendorConfiguration Map<String,String>

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

wanInterfaceId String
zoneCode String

Device location zone code.

accountNumber string

Billing account number for secondary device.

metroCode string

Metro location of a secondary device.

name string

Secondary device name.

notifications string[]

List of email addresses that will receive notifications about secondary device.

aclTemplateId string

Identifier of a WAN interface ACL template that will be applied on a secondary device.

additionalBandwidth number

Additional Internet bandwidth, in Mbps, for a secondary device.

asn number

(Autonomous System Number) Unique identifier for a network on the internet.

cloudInitFileId string

Identifier of a cloud init file that will be applied on a secondary device.

hostname string

Secondary device hostname.

ibx string

Device location Equinix Business Exchange name.

interfaces DeviceSecondaryDeviceInterface[]

List of device interfaces. See Interface Attribute below for more details.

licenseFile string

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

licenseFileId string

Identifier of a license file that will be applied on a secondary device.

licenseStatus string

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken string

License Token can be provided for some device types o the device.

mgmtAclTemplateUuid string

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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.

sshKey DeviceSecondaryDeviceSshKey
status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid string

Device unique identifier.

vendorConfiguration {[key: string]: string}

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

wanInterfaceId string
zoneCode string

Device location zone code.

account_number str

Billing account number for secondary device.

metro_code str

Metro location of a secondary device.

name str

Secondary device name.

notifications Sequence[str]

List of email addresses that will receive notifications about secondary device.

acl_template_id str

Identifier of a WAN interface ACL template that will be applied on a secondary device.

additional_bandwidth int

Additional Internet bandwidth, in Mbps, for a secondary device.

asn int

(Autonomous System Number) Unique identifier for a network on the internet.

cloud_init_file_id str

Identifier of a cloud init file that will be applied on a secondary device.

hostname str

Secondary device hostname.

ibx str

Device location Equinix Business Exchange name.

interfaces Sequence[DeviceSecondaryDeviceInterface]

List of device interfaces. See Interface Attribute below for more details.

license_file str

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

license_file_id str

Identifier of a license file that will be applied on a secondary device.

license_status str

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

license_token str

License Token can be provided for some device types o the device.

mgmt_acl_template_uuid str

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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_key DeviceSecondaryDeviceSshKey
status str

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid str

Device unique identifier.

vendor_configuration Mapping[str, str]

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

wan_interface_id str
zone_code str

Device location zone code.

accountNumber String

Billing account number for secondary device.

metroCode String

Metro location of a secondary device.

name String

Secondary device name.

notifications List<String>

List of email addresses that will receive notifications about secondary device.

aclTemplateId String

Identifier of a WAN interface ACL template that will be applied on a secondary device.

additionalBandwidth Number

Additional Internet bandwidth, in Mbps, for a secondary device.

asn Number

(Autonomous System Number) Unique identifier for a network on the internet.

cloudInitFileId String

Identifier of a cloud init file that will be applied on a secondary device.

hostname String

Secondary device hostname.

ibx String

Device location Equinix Business Exchange name.

interfaces List<Property Map>

List of device interfaces. See Interface Attribute below for more details.

licenseFile String

Path to the license file that will be uploaded and applied on a secondary device. Applicable for some device types in BYOL licensing mode.

licenseFileId String

Identifier of a license file that will be applied on a secondary device.

licenseStatus String

Device license registration status. Possible values are APPLYING_LICENSE, REGISTERED, APPLIED, WAITING_FOR_CLUSTER_SETUP, REGISTRATION_FAILED.

licenseToken String

License Token can be provided for some device types o the device.

mgmtAclTemplateUuid String

Identifier of an MGMT interface ACL template that will be applied on a secondary device.

  • ssh-key - (Optional) Up to one definition of SSH key that will be provisioned on a secondary device.
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.

sshKey Property Map
status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

uuid String

Device unique identifier.

vendorConfiguration Map<String>

Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are controller1, activationKey, managementType, siteId, systemIpAddress.

wanInterfaceId String
zoneCode String

Device location zone code.

DeviceSecondaryDeviceInterface

AssignedType string

interface management type (Equinix Managed or empty).

Id int

interface identifier.

IpAddress string

interface IP address.

MacAddress string

interface MAC address.

Name string

Device name.

OperationalStatus string

interface operational status. One of up, down.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

Name string

Device name.

OperationalStatus string

interface operational status. One of up, down.

Status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name String

Device name.

operationalStatus String

interface operational status. One of up, down.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name string

Device name.

operationalStatus string

interface operational status. One of up, down.

status string

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name str

Device name.

operational_status str

interface operational status. One of up, down.

status str

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

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 address.

name String

Device name.

operationalStatus String

interface operational status. One of up, down.

status String

interface status. One of AVAILABLE, RESERVED, ASSIGNED.

type String

interface type.

DeviceSecondaryDeviceSshKey

KeyName string
Username string

username associated with given key.

KeyName string
Username string

username associated with given key.

keyName String
username String

username associated with given key.

keyName string
username string

username associated with given key.

key_name str
username str

username associated with given key.

keyName String
username String

username associated with given key.

DeviceSshKey

KeyName string
Username string

username associated with given key.

KeyName string
Username string

username associated with given key.

keyName String
username String

username associated with given key.

keyName string
username string

username associated with given key.

key_name str
username str

username associated with given key.

keyName String
username String

username associated with given key.

ThroughputUnit

Mbps
Mbps
Gbps
Gbps
ThroughputUnitMbps
Mbps
ThroughputUnitGbps
Gbps
Mbps
Mbps
Gbps
Gbps
Mbps
Mbps
Gbps
Gbps
MBPS
Mbps
GBPS
Gbps
"Mbps"
Mbps
"Gbps"
Gbps

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes

This Pulumi package is based on the equinix Terraform Provider.