
Equinix v0.2.1, May 4 23

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:
- Account
Number string Billing account number for a device.
- Core
Count int Number of CPU cores used by device.
- Metro
Code string Device location metro code.
- Notifications List<string>
List of email addresses that will receive device status notifications.
- Package
Code string Device software package code.
- Term
Length int Device term length.
- Type
Code string Device type code.
- Version string
Device software software version.
- Acl
Template stringId 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
orsubscription
(default).- Cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- Cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- Hostname string
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 string 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 stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Mgmt
Acl stringTemplate Uuid Identifier of an MGMT interface ACL template that will be applied on the device.
- Name string
Device name.
- Order
Reference string Name/number used to identify device order on the invoice.
- Purchase
Order stringNumber Purchase order number associated with a device order.
- Secondary
Device DeviceSecondary Device Args 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
orEquinix-managed
(default).- Ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- Throughput int
Device license throughput.
- Throughput
Unit string | Pulumi.Equinix. Network Edge. Throughput Unit License throughput unit. One of
Mbps
orGbps
.- Vendor
Configuration 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.
- Wan
Interface stringId device interface id picked for WAN
- Account
Number string Billing account number for a device.
- Core
Count int Number of CPU cores used by device.
- Metro
Code string Device location metro code.
- Notifications []string
List of email addresses that will receive device status notifications.
- Package
Code string Device software package code.
- Term
Length int Device term length.
- Type
Code string Device type code.
- Version string
Device software software version.
- Acl
Template stringId 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
orsubscription
(default).- Cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- Cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- Hostname string
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 string 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 stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Mgmt
Acl stringTemplate Uuid Identifier of an MGMT interface ACL template that will be applied on the device.
- Name string
Device name.
- Order
Reference string Name/number used to identify device order on the invoice.
- Purchase
Order stringNumber Purchase order number associated with a device order.
- Secondary
Device DeviceSecondary Device Args 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
orEquinix-managed
(default).- Ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- Throughput int
Device license throughput.
- Throughput
Unit string | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- Vendor
Configuration 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.
- Wan
Interface stringId device interface id picked for WAN
- account
Number String Billing account number for a device.
- core
Count Integer Number of CPU cores used by device.
- metro
Code String Device location metro code.
- notifications List<String>
List of email addresses that will receive device status notifications.
- package
Code String Device software package code.
- term
Length Integer Device term length.
- type
Code String Device type code.
- version String
Device software software version.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init StringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- hostname String
Device hostname prefix.
- interface
Count Integer Number of network interfaces on a device. If not specified, default number for a given device type will be used.
- license
File String 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- mgmt
Acl StringTemplate Uuid Identifier of an MGMT interface ACL template that will be applied on the device.
- name String
Device name.
- order
Reference String Name/number used to identify device order on the invoice.
- purchase
Order StringNumber Purchase order number associated with a device order.
- secondary
Device DeviceSecondary Device Args Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed Boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- throughput Integer
Device license throughput.
- throughput
Unit String | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- vendor
Configuration 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.
- wan
Interface StringId device interface id picked for WAN
- account
Number string Billing account number for a device.
- core
Count number Number of CPU cores used by device.
- metro
Code string Device location metro code.
- notifications string[]
List of email addresses that will receive device status notifications.
- package
Code string Device software package code.
- term
Length number Device term length.
- type
Code string Device type code.
- version string
Device software software version.
- acl
Template stringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- hostname string
Device hostname prefix.
- interface
Count number Number of network interfaces on a device. If not specified, default number for a given device type will be used.
- license
File string 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 stringId Identifier of a license file that will be applied on the device.
- license
Token string License Token applicable for some device types in BYOL licensing mode.
- mgmt
Acl stringTemplate Uuid Identifier of an MGMT interface ACL template that will be applied on the device.
- name string
Device name.
- order
Reference string Name/number used to identify device order on the invoice.
- purchase
Order stringNumber Purchase order number associated with a device order.
- secondary
Device DeviceSecondary Device Args Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- throughput number
Device license throughput.
- throughput
Unit string | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- vendor
Configuration {[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.
- wan
Interface stringId 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_ strid 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
orsubscription
(default).- cloud_
init_ strfile_ id Identifier of a cloud init file that will be applied on the device.
- cluster_
details DeviceCluster Details Args 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_ strid 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_ strtemplate_ uuid 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_ strnumber Purchase order number associated with a device order.
- secondary_
device DeviceSecondary Device Args 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
orEquinix-managed
(default).- ssh_
key DeviceSsh Key Args 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
orGbps
.- 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_ strid device interface id picked for WAN
- account
Number String Billing account number for a device.
- core
Count Number Number of CPU cores used by device.
- metro
Code String Device location metro code.
- notifications List<String>
List of email addresses that will receive device status notifications.
- package
Code String Device software package code.
- term
Length Number Device term length.
- type
Code String Device type code.
- version String
Device software software version.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init StringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details Property Map An object that has the cluster details. See Cluster Details below for more details.
- hostname String
Device hostname prefix.
- interface
Count Number Number of network interfaces on a device. If not specified, default number for a given device type will be used.
- license
File String 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- mgmt
Acl StringTemplate Uuid Identifier of an MGMT interface ACL template that will be applied on the device.
- name String
Device name.
- order
Reference String Name/number used to identify device order on the invoice.
- purchase
Order StringNumber Purchase order number associated with a device order.
- secondary
Device Property Map Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed Boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Key Property Map Definition of SSH key that will be provisioned on a device
- throughput Number
Device license throughput.
- throughput
Unit String | "Mbps" | "Gbps" License throughput unit. One of
Mbps
orGbps
.- vendor
Configuration 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.
- wan
Interface StringId 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<Device
Interface> List of device interfaces. See Interface Attribute below for more details.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- Redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Uuid string
Device unique identifier.
- Zone
Code 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
[]Device
Interface List of device interfaces. See Interface Attribute below for more details.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- Redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Uuid string
Device unique identifier.
- Zone
Code 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<Device
Interface> List of device interfaces. See Interface Attribute below for more details.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- redundancy
Type String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid String
Device unique identifier.
- zone
Code 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
Device
Interface[] List of device interfaces. See Interface Attribute below for more details.
- license
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- region string
Device location region.
- ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid string
Device unique identifier.
- zone
Code 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[Device
Interface] 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_ straddress IP address of SSH enabled interface on the device.
- ssh_
ip_ strfqdn 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.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- redundancy
Type String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid String
Device unique identifier.
- zone
Code 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.
- Account
Number string Billing account number for a device.
- Acl
Template stringId 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
orsubscription
(default).- Cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- Cluster
Details DeviceCluster Details Args 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 string
Device hostname prefix.
- Ibx string
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
List<Device
Interface Args> List of device interfaces. See Interface Attribute below for more details.
- License
File string 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 stringId Identifier of a license file that will be applied on the device.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Metro
Code string Device location metro code.
- Mgmt
Acl stringTemplate Uuid 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.
- Order
Reference string Name/number used to identify device order on the invoice.
- Package
Code string Device software package code.
- Purchase
Order stringNumber Purchase order number associated with a device order.
- Redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Secondary
Device DeviceSecondary Device Args 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
orEquinix-managed
(default).- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Term
Length int Device term length.
- Throughput int
Device license throughput.
- Throughput
Unit string | Pulumi.Equinix. Network Edge. Throughput Unit License throughput unit. One of
Mbps
orGbps
.- Type
Code string Device type code.
- Uuid string
Device unique identifier.
- Vendor
Configuration 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.
- Wan
Interface stringId device interface id picked for WAN
- Zone
Code string Device location zone code.
- Account
Number string Billing account number for a device.
- Acl
Template stringId 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
orsubscription
(default).- Cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- Cluster
Details DeviceCluster Details Args 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 string
Device hostname prefix.
- Ibx string
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
[]Device
Interface Args List of device interfaces. See Interface Attribute below for more details.
- License
File string 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 stringId Identifier of a license file that will be applied on the device.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Metro
Code string Device location metro code.
- Mgmt
Acl stringTemplate Uuid 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.
- Order
Reference string Name/number used to identify device order on the invoice.
- Package
Code string Device software package code.
- Purchase
Order stringNumber Purchase order number associated with a device order.
- Redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Secondary
Device DeviceSecondary Device Args 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
orEquinix-managed
(default).- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Term
Length int Device term length.
- Throughput int
Device license throughput.
- Throughput
Unit string | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- Type
Code string Device type code.
- Uuid string
Device unique identifier.
- Vendor
Configuration 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.
- Wan
Interface stringId device interface id picked for WAN
- Zone
Code string Device location zone code.
- account
Number String Billing account number for a device.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init StringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- core
Count Integer Number of CPU cores used by device.
- hostname String
Device hostname prefix.
- ibx String
Device location Equinix Business Exchange name.
- interface
Count Integer Number of network interfaces on a device. If not specified, default number for a given device type will be used.
- interfaces
List<Device
Interface Args> List of device interfaces. See Interface Attribute below for more details.
- license
File String 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 StringId Identifier of a license file that will be applied on the device.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token String License Token applicable for some device types in BYOL licensing mode.
- metro
Code String Device location metro code.
- mgmt
Acl StringTemplate Uuid 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.
- order
Reference String Name/number used to identify device order on the invoice.
- package
Code String Device software package code.
- purchase
Order StringNumber Purchase order number associated with a device order.
- redundancy
Type String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- secondary
Device DeviceSecondary Device Args Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed Boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- term
Length Integer Device term length.
- throughput Integer
Device license throughput.
- throughput
Unit String | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- type
Code String Device type code.
- uuid String
Device unique identifier.
- vendor
Configuration 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.
- wan
Interface StringId device interface id picked for WAN
- zone
Code String Device location zone code.
- account
Number string Billing account number for a device.
- acl
Template stringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init stringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details DeviceCluster Details Args An object that has the cluster details. See Cluster Details below for more details.
- core
Count number Number of CPU cores used by device.
- hostname string
Device hostname prefix.
- ibx string
Device location Equinix Business Exchange name.
- interface
Count number Number of network interfaces on a device. If not specified, default number for a given device type will be used.
- interfaces
Device
Interface Args[] List of device interfaces. See Interface Attribute below for more details.
- license
File string 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 stringId Identifier of a license file that will be applied on the device.
- license
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token string License Token applicable for some device types in BYOL licensing mode.
- metro
Code string Device location metro code.
- mgmt
Acl stringTemplate Uuid 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.
- order
Reference string Name/number used to identify device order on the invoice.
- package
Code string Device software package code.
- purchase
Order stringNumber Purchase order number associated with a device order.
- redundancy
Type string Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- region string
Device location region.
- secondary
Device DeviceSecondary Device Args Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key DeviceSsh Key Args Definition of SSH key that will be provisioned on a device
- status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- term
Length number Device term length.
- throughput number
Device license throughput.
- throughput
Unit string | ThroughputUnit License throughput unit. One of
Mbps
orGbps
.- type
Code string Device type code.
- uuid string
Device unique identifier.
- vendor
Configuration {[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.
- wan
Interface stringId device interface id picked for WAN
- zone
Code string Device location zone code.
- account_
number str Billing account number for a device.
- acl_
template_ strid 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
orsubscription
(default).- cloud_
init_ strfile_ id Identifier of a cloud init file that will be applied on the device.
- cluster_
details DeviceCluster Details Args 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[Device
Interface Args] 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_ strid 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_ strtemplate_ uuid 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_ strnumber 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 DeviceSecondary Device Args 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
orEquinix-managed
(default).- ssh_
ip_ straddress IP address of SSH enabled interface on the device.
- ssh_
ip_ strfqdn FQDN of SSH enabled interface on the device.
- ssh_
key DeviceSsh Key Args 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
orGbps
.- 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_ strid device interface id picked for WAN
- zone_
code str Device location zone code.
- account
Number String Billing account number for a device.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on the device.
- additional
Bandwidth 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
orsubscription
(default).- cloud
Init StringFile Id Identifier of a cloud init file that will be applied on the device.
- cluster
Details Property Map An object that has the cluster details. See Cluster Details below for more details.
- core
Count Number Number of CPU cores used by device.
- hostname String
Device hostname prefix.
- ibx String
Device location Equinix Business Exchange name.
- interface
Count 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.
- license
File String 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 StringId Identifier of a license file that will be applied on the device.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token String License Token applicable for some device types in BYOL licensing mode.
- metro
Code String Device location metro code.
- mgmt
Acl StringTemplate Uuid 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.
- order
Reference String Name/number used to identify device order on the invoice.
- package
Code String Device software package code.
- purchase
Order StringNumber Purchase order number associated with a device order.
- redundancy
Type String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- secondary
Device Property Map Definition of secondary device for redundant device configurations. See Secondary Device below for more details.
- self
Managed Boolean Boolean value that determines device management mode, i.e.,
self-managed
orEquinix-managed
(default).- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key Property Map Definition of SSH key that will be provisioned on a device
- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- term
Length Number Device term length.
- throughput Number
Device license throughput.
- throughput
Unit String | "Mbps" | "Gbps" License throughput unit. One of
Mbps
orGbps
.- type
Code String Device type code.
- uuid String
Device unique identifier.
- vendor
Configuration 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.
- wan
Interface StringId device interface id picked for WAN
- zone
Code String Device location zone code.
Supporting Types
DeviceClusterDetails
- Cluster
Name string The name of the cluster device
- Node0
Device
Cluster Details Node0 An object that has
node0
configuration. See Cluster Details - Nodes below for more details.- Node1
Device
Cluster Details Node1 An object that has
node1
configuration. See Cluster Details - Nodes below for more details.- Cluster
Id string The ID of the cluster.
- Num
Of intNodes The number of nodes in the cluster.
- Cluster
Name string The name of the cluster device
- Node0
Device
Cluster Details Node0 An object that has
node0
configuration. See Cluster Details - Nodes below for more details.- Node1
Device
Cluster Details Node1 An object that has
node1
configuration. See Cluster Details - Nodes below for more details.- Cluster
Id string The ID of the cluster.
- Num
Of intNodes The number of nodes in the cluster.
- cluster
Name String The name of the cluster device
- node0
Device
Cluster Details Node0 An object that has
node0
configuration. See Cluster Details - Nodes below for more details.- node1
Device
Cluster Details Node1 An object that has
node1
configuration. See Cluster Details - Nodes below for more details.- cluster
Id String The ID of the cluster.
- num
Of IntegerNodes The number of nodes in the cluster.
- cluster
Name string The name of the cluster device
- node0
Device
Cluster Details Node0 An object that has
node0
configuration. See Cluster Details - Nodes below for more details.- node1
Device
Cluster Details Node1 An object that has
node1
configuration. See Cluster Details - Nodes below for more details.- cluster
Id string The ID of the cluster.
- num
Of numberNodes The number of nodes in the cluster.
- cluster_
name str The name of the cluster device
- node0
Device
Cluster Details Node0 An object that has
node0
configuration. See Cluster Details - Nodes below for more details.- node1
Device
Cluster Details Node1 An object that has
node1
configuration. See Cluster Details - Nodes below for more details.- cluster_
id str The ID of the cluster.
- num_
of_ intnodes The number of nodes in the cluster.
- cluster
Name 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.- cluster
Id String The ID of the cluster.
- num
Of NumberNodes The number of nodes in the cluster.
DeviceClusterDetailsNode0
- License
File stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Name string
Device name.
- Uuid string
Device unique identifier.
- Vendor
Configuration DeviceCluster Details Node0Vendor Configuration 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 stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Name string
Device name.
- Uuid string
Device unique identifier.
- Vendor
Configuration DeviceCluster Details Node0Vendor Configuration 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- name String
Device name.
- uuid String
Device unique identifier.
- vendor
Configuration DeviceCluster Details Node0Vendor Configuration 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 stringId Identifier of a license file that will be applied on the device.
- license
Token string License Token applicable for some device types in BYOL licensing mode.
- name string
Device name.
- uuid string
Device unique identifier.
- vendor
Configuration DeviceCluster Details Node0Vendor Configuration 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_ strid 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 DeviceCluster Details Node0Vendor Configuration 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- name String
Device name.
- uuid String
Device unique identifier.
- vendor
Configuration 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
- Activation
Key string Activation key. This is required for Velocloud clusters.
- Admin
Password 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.
- Controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- Hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- Root
Password string The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- Activation
Key string Activation key. This is required for Velocloud clusters.
- Admin
Password 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.
- Controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- Hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- Root
Password string The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- activation
Key String Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn String Controller fqdn. This is required for Velocloud clusters.
- hostname String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password String The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- activation
Key string Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password 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.
- activation
Key String Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn String Controller fqdn. This is required for Velocloud clusters.
- hostname String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password String The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
DeviceClusterDetailsNode1
- License
File stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Name string
Device name.
- Uuid string
Device unique identifier.
- Vendor
Configuration DeviceCluster Details Node1Vendor Configuration 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 stringId Identifier of a license file that will be applied on the device.
- License
Token string License Token applicable for some device types in BYOL licensing mode.
- Name string
Device name.
- Uuid string
Device unique identifier.
- Vendor
Configuration DeviceCluster Details Node1Vendor Configuration 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- name String
Device name.
- uuid String
Device unique identifier.
- vendor
Configuration DeviceCluster Details Node1Vendor Configuration 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 stringId Identifier of a license file that will be applied on the device.
- license
Token string License Token applicable for some device types in BYOL licensing mode.
- name string
Device name.
- uuid string
Device unique identifier.
- vendor
Configuration DeviceCluster Details Node1Vendor Configuration 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_ strid 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 DeviceCluster Details Node1Vendor Configuration 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 StringId Identifier of a license file that will be applied on the device.
- license
Token String License Token applicable for some device types in BYOL licensing mode.
- name String
Device name.
- uuid String
Device unique identifier.
- vendor
Configuration 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
- Activation
Key string Activation key. This is required for Velocloud clusters.
- Admin
Password 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.
- Controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- Hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- Root
Password string The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- Activation
Key string Activation key. This is required for Velocloud clusters.
- Admin
Password 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.
- Controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- Hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- Root
Password string The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- activation
Key String Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn String Controller fqdn. This is required for Velocloud clusters.
- hostname String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password String The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
- activation
Key string Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn string Controller fqdn. This is required for Velocloud clusters.
- hostname string
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password 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.
- activation
Key String Activation key. This is required for Velocloud clusters.
- admin
Password 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.
- controller
Fqdn String Controller fqdn. This is required for Velocloud clusters.
- hostname String
Hostname. This is necessary for Palo Alto, Juniper, and Fortinet clusters.
- root
Password String The CLI password of the device. This field is relevant only for the Velocloud SDWAN cluster.
DeviceInterface
- Assigned
Type string interface management type (Equinix Managed or empty).
- Id int
interface identifier.
- Ip
Address string interface IP address.
- Mac
Address string interface MAC address.
- Name string
Device name.
- Operational
Status string interface operational status. One of
up
,down
.- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Type string
interface type.
- Assigned
Type string interface management type (Equinix Managed or empty).
- Id int
interface identifier.
- Ip
Address string interface IP address.
- Mac
Address string interface MAC address.
- Name string
Device name.
- Operational
Status string interface operational status. One of
up
,down
.- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Type string
interface type.
- assigned
Type String interface management type (Equinix Managed or empty).
- id Integer
interface identifier.
- ip
Address String interface IP address.
- mac
Address String interface MAC address.
- name String
Device name.
- operational
Status String interface operational status. One of
up
,down
.- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- type String
interface type.
- assigned
Type string interface management type (Equinix Managed or empty).
- id number
interface identifier.
- ip
Address string interface IP address.
- mac
Address string interface MAC address.
- name string
Device name.
- operational
Status 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.
- assigned
Type String interface management type (Equinix Managed or empty).
- id Number
interface identifier.
- ip
Address String interface IP address.
- mac
Address String interface MAC address.
- name String
Device name.
- operational
Status String interface operational status. One of
up
,down
.- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- type String
interface type.
DeviceSecondaryDevice
- Account
Number string Billing account number for secondary device.
- Metro
Code 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.
- Acl
Template stringId 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 stringFile Id 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<Device
Secondary Device Interface> List of device interfaces. See Interface Attribute below for more details.
- License
File 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.
- License
File stringId Identifier of a license file that will be applied on a secondary device.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- License
Token string License Token can be provided for some device types o the device.
- Mgmt
Acl stringTemplate Uuid 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 string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Ssh
Key DeviceSecondary Device Ssh Key - Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Uuid string
Device unique identifier.
- Vendor
Configuration Dictionary<string, string> Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are
controller1
,activationKey
,managementType
,siteId
,systemIpAddress
.- Wan
Interface stringId - Zone
Code string Device location zone code.
- Account
Number string Billing account number for secondary device.
- Metro
Code 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.
- Acl
Template stringId 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 stringFile Id 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
[]Device
Secondary Device Interface List of device interfaces. See Interface Attribute below for more details.
- License
File 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.
- License
File stringId Identifier of a license file that will be applied on a secondary device.
- License
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- License
Token string License Token can be provided for some device types o the device.
- Mgmt
Acl stringTemplate Uuid 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 string Device redundancy type applicable for HA devices, either primary or secondary.
- Redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- Region string
Device location region.
- Ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- Ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- Ssh
Key DeviceSecondary Device Ssh Key - Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Uuid string
Device unique identifier.
- Vendor
Configuration map[string]string Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are
controller1
,activationKey
,managementType
,siteId
,systemIpAddress
.- Wan
Interface stringId - Zone
Code string Device location zone code.
- account
Number String Billing account number for secondary device.
- metro
Code 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.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on a secondary device.
- additional
Bandwidth Integer Additional Internet bandwidth, in Mbps, for a secondary device.
- asn Integer
(Autonomous System Number) Unique identifier for a network on the internet.
- cloud
Init StringFile Id 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<Device
Secondary Device Interface> List of device interfaces. See Interface Attribute below for more details.
- license
File 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.
- license
File StringId Identifier of a license file that will be applied on a secondary device.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token String License Token can be provided for some device types o the device.
- mgmt
Acl StringTemplate Uuid 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 String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key DeviceSecondary Device Ssh Key - status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid String
Device unique identifier.
- vendor
Configuration Map<String,String> Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are
controller1
,activationKey
,managementType
,siteId
,systemIpAddress
.- wan
Interface StringId - zone
Code String Device location zone code.
- account
Number string Billing account number for secondary device.
- metro
Code 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.
- acl
Template stringId Identifier of a WAN interface ACL template that will be applied on a secondary device.
- additional
Bandwidth number Additional Internet bandwidth, in Mbps, for a secondary device.
- asn number
(Autonomous System Number) Unique identifier for a network on the internet.
- cloud
Init stringFile Id 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
Device
Secondary Device Interface[] List of device interfaces. See Interface Attribute below for more details.
- license
File 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.
- license
File stringId Identifier of a license file that will be applied on a secondary device.
- license
Status string Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token string License Token can be provided for some device types o the device.
- mgmt
Acl stringTemplate Uuid 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 string Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id string Unique identifier for a redundant device applicable for HA devices.
- region string
Device location region.
- ssh
Ip stringAddress IP address of SSH enabled interface on the device.
- ssh
Ip stringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key DeviceSecondary Device Ssh Key - status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid string
Device unique identifier.
- vendor
Configuration {[key: string]: string} Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are
controller1
,activationKey
,managementType
,siteId
,systemIpAddress
.- wan
Interface stringId - zone
Code 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_ strid 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_ strfile_ id 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[Device
Secondary Device Interface] 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_ strid 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_ strtemplate_ uuid 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_ straddress IP address of SSH enabled interface on the device.
- ssh_
ip_ strfqdn FQDN of SSH enabled interface on the device.
- ssh_
key DeviceSecondary Device Ssh Key - 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_ strid - zone_
code str Device location zone code.
- account
Number String Billing account number for secondary device.
- metro
Code 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.
- acl
Template StringId Identifier of a WAN interface ACL template that will be applied on a secondary device.
- additional
Bandwidth Number Additional Internet bandwidth, in Mbps, for a secondary device.
- asn Number
(Autonomous System Number) Unique identifier for a network on the internet.
- cloud
Init StringFile Id 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.
- license
File 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.
- license
File StringId Identifier of a license file that will be applied on a secondary device.
- license
Status String Device license registration status. Possible values are
APPLYING_LICENSE
,REGISTERED
,APPLIED
,WAITING_FOR_CLUSTER_SETUP
,REGISTRATION_FAILED
.- license
Token String License Token can be provided for some device types o the device.
- mgmt
Acl StringTemplate Uuid 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 String Device redundancy type applicable for HA devices, either primary or secondary.
- redundant
Id String Unique identifier for a redundant device applicable for HA devices.
- region String
Device location region.
- ssh
Ip StringAddress IP address of SSH enabled interface on the device.
- ssh
Ip StringFqdn FQDN of SSH enabled interface on the device.
- ssh
Key Property Map - status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- uuid String
Device unique identifier.
- vendor
Configuration Map<String> Key/Value pairs of vendor specific configuration parameters for a secondary device. Key values are
controller1
,activationKey
,managementType
,siteId
,systemIpAddress
.- wan
Interface StringId - zone
Code String Device location zone code.
DeviceSecondaryDeviceInterface
- Assigned
Type string interface management type (Equinix Managed or empty).
- Id int
interface identifier.
- Ip
Address string interface IP address.
- Mac
Address string interface MAC address.
- Name string
Device name.
- Operational
Status string interface operational status. One of
up
,down
.- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Type string
interface type.
- Assigned
Type string interface management type (Equinix Managed or empty).
- Id int
interface identifier.
- Ip
Address string interface IP address.
- Mac
Address string interface MAC address.
- Name string
Device name.
- Operational
Status string interface operational status. One of
up
,down
.- Status string
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- Type string
interface type.
- assigned
Type String interface management type (Equinix Managed or empty).
- id Integer
interface identifier.
- ip
Address String interface IP address.
- mac
Address String interface MAC address.
- name String
Device name.
- operational
Status String interface operational status. One of
up
,down
.- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- type String
interface type.
- assigned
Type string interface management type (Equinix Managed or empty).
- id number
interface identifier.
- ip
Address string interface IP address.
- mac
Address string interface MAC address.
- name string
Device name.
- operational
Status 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.
- assigned
Type String interface management type (Equinix Managed or empty).
- id Number
interface identifier.
- ip
Address String interface IP address.
- mac
Address String interface MAC address.
- name String
Device name.
- operational
Status String interface operational status. One of
up
,down
.- status String
interface status. One of
AVAILABLE
,RESERVED
,ASSIGNED
.- type String
interface type.
DeviceSecondaryDeviceSshKey
DeviceSshKey
ThroughputUnit
- Mbps
- Mbps
- Gbps
- Gbps
- Throughput
Unit Mbps - Mbps
- Throughput
Unit Gbps - 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.