client.go

// Package ne implements Network Edge client
package ne

import (
	"fmt"
	"io"
)

const (
	//DeviceStateInitializing Equinix is allocating resources and creating new device
	DeviceStateInitializing = "INITIALIZING"
	//DeviceStateProvisioning Network Edge device is booting
	DeviceStateProvisioning = "PROVISIONING"
	//DeviceStateWaitingPrimary secondary Network Edge device is waiting for provisioning of its redundant (primary) device
	DeviceStateWaitingPrimary = "WAITING_FOR_PRIMARY"
	//DeviceStateWaitingSecondary primary Network Edge device is waiting for provisioning of its redundant (secondary) device
	DeviceStateWaitingSecondary = "WAITING_FOR_SECONDARY"
	//DeviceStateWaitingClusterNodes primary Network Edge device is waiting for provisioning of its cluster devices
	DeviceStateWaitingClusterNodes = "WAITING_FOR_REPLICA_CLUSTER_NODES"
	//DeviceStateClusterSetUpInProgress The cluster setup is in progress
	DeviceStateClusterSetUpInProgress = "CLUSTER_SETUP_IN_PROGRESS"
	//DeviceStateFailed Network Edge device creation and provisioning have failed
	DeviceStateFailed = "FAILED"
	//DeviceStateProvisioned Network Edge device was successfully provisioned and is fully operational
	DeviceStateProvisioned = "PROVISIONED"
	//DeviceStateDeprovisioning Network Edge device is in process of deprovisioning
	DeviceStateDeprovisioning = "DEPROVISIONING"
	//DeviceStateDeprovisioned Network Edge device was successfully deprovisioned
	DeviceStateDeprovisioned = "DEPROVISIONED"
	//DeviceStateResourceUpgradeInProgress Network Edge device is in process of resource upgrade
	DeviceStateResourceUpgradeInProgress = "RESOURCE_UPGRADE_IN_PROGRESS"
	//DeviceStateResourceUpgradeFailed Network Edge device resource upgrade has failed
	DeviceStateResourceUpgradeFailed = "RESOURCE_UPGRADE_FAILED"

	//DeviceLicenseStateApplying license is in registration process
	DeviceLicenseStateApplying = "APPLYING_LICENSE"
	//DeviceLicenseStateRegistered license was successfully registered
	DeviceLicenseStateRegistered = "REGISTERED"
	//DeviceLicenseStateApplied license was successfully applied
	DeviceLicenseStateApplied = "APPLIED"
	//DeviceLicenseStateNA license state not applicable
	DeviceLicenseStateNA = "N/A"
	//DeviceLicenseStateFailed license registration has failed
	DeviceLicenseStateFailed = "REGISTRATION_FAILED"
	//DeviceLicenseStateWaitingClusterSetUp license is waiting for cluster setup
	DeviceLicenseStateWaitingClusterSetUp = "WAITING_FOR_CLUSTER_SETUP"

	//BGPStateIdle BGP peer state is idle
	BGPStateIdle = "Idle"
	//BGPStateConnect BGP peer state is connect
	BGPStateConnect = "Connect"
	//BGPStateActive BGP peer state is active
	BGPStateActive = "Active"
	//BGPStateOpenSent BGP peer state is OpenSent
	BGPStateOpenSent = "OpenSent"
	//BGPStateOpenConnect BGP peer state is OpenConfirm
	BGPStateOpenConnect = "OpenConfirm"
	//BGPStateEstablished BGP peer state is Established
	BGPStateEstablished = "Established"
	//BGPProvisioningStatusProvisioning BGP peering is provisioning
	BGPProvisioningStatusProvisioning = "PROVISIONING"
	//BGPProvisioningStatusPendingUpdate BGP peering is being updated
	BGPProvisioningStatusPendingUpdate = "PENDING_UPDATE"
	//BGPProvisioningStatusProvisioned BGP peering is provisioned
	BGPProvisioningStatusProvisioned = "PROVISIONED"
	//BGPProvisioningStatusFailed BGP peering failed
	BGPProvisioningStatusFailed = "FAILED"

	//ACLDeviceStatusProvisioning indicates that ACL is being provisioned on a device
	ACLDeviceStatusProvisioning = "PROVISIONING"
	//ACLDeviceStatusProvisioned indicates that ACL was successfully provisioned on a device
	ACLDeviceStatusProvisioned = "PROVISIONED"

	//ErrorCodeDeviceRemoved is used on attempt to remove device that is deprovisioning or already deprovisioned
	ErrorCodeDeviceRemoved = "EQ-4006103"

	//ErrorCodeSSHPublicKeyInvalid is an error code returned when invalid
	//SSH public key identifier was used
	ErrorCodeSSHPublicKeyInvalid = "EQ-4010206"

	//DeviceAdditionalBandwidthStatusProvisioning additional bandwidth is provisioning
	DeviceAdditionalBandwidthStatusProvisioning = "PROVISIONING"
	//DeviceAdditionalBandwidthStatusProvisioned additional bandwidth is provisioned
	DeviceAdditionalBandwidthStatusProvisioned = "PROVISIONED"

	//DeviceLinkGroupStatusProvisioning indicates that device link is provisioning
	DeviceLinkGroupStatusProvisioning = "PROVISIONING"
	//DeviceLinkGroupStatusProvisioned indicates that device link was provisioned
	DeviceLinkGroupStatusProvisioned = "PROVISIONED"
	//DeviceLinkGroupStatusDeprovisioning indicates that device link is deprovisioning
	DeviceLinkGroupStatusDeprovisioning = "DEPROVISIONING"
	//DeviceLinkGroupStatusProvisioned indicates that device link was deprovisioned
	DeviceLinkGroupStatusDeprovisioned = "DEPROVISIONED"
)

// Client interface describes operations provided by Network Edge client library
type Client interface {
	GetAccounts(metroCode string) ([]Account, error)
	GetDeviceTypes() ([]DeviceType, error)
	GetDevicePlatforms(deviceTypeCode string) ([]DevicePlatform, error)
	GetDeviceSoftwareVersions(deviceTypeCode string) ([]DeviceSoftwareVersion, error)

	CreateDevice(device Device) (*string, error)
	CreateRedundantDevice(primary Device, secondary Device) (*string, *string, error)
	GetDevice(uuid string) (*Device, error)
	GetDevices(statuses []string) ([]Device, error)
	GetDeviceAdditionalBandwidthDetails(uuid string) (*DeviceAdditionalBandwidthDetails, error)
	GetDeviceACLDetails(uuid string) (*DeviceACLDetails, error)
	NewDeviceUpdateRequest(uuid string) DeviceUpdateRequest
	DeleteDevice(uuid string) error

	CreateSSHUser(username string, password string, device string) (*string, error)
	GetSSHUsers() ([]SSHUser, error)
	GetSSHUser(uuid string) (*SSHUser, error)
	NewSSHUserUpdateRequest(uuid string) SSHUserUpdateRequest
	DeleteSSHUser(uuid string) error

	CreateBGPConfiguration(config BGPConfiguration) (*string, error)
	GetBGPConfiguration(uuid string) (*BGPConfiguration, error)
	NewBGPConfigurationUpdateRequest(uuid string) BGPUpdateRequest
	GetBGPConfigurationForConnection(uuid string) (*BGPConfiguration, error)

	GetSSHPublicKeys() ([]SSHPublicKey, error)
	GetSSHPublicKey(uuid string) (*SSHPublicKey, error)
	CreateSSHPublicKey(key SSHPublicKey) (*string, error)
	DeleteSSHPublicKey(uuid string) error

	CreateACLTemplate(template ACLTemplate) (*string, error)
	GetACLTemplates() ([]ACLTemplate, error)
	GetACLTemplate(uuid string) (*ACLTemplate, error)
	ReplaceACLTemplate(uuid string, template ACLTemplate) error
	DeleteACLTemplate(uuid string) error

	UploadLicenseFile(metroCode, deviceTypeCode, deviceManagementMode, licenseMode, fileName string, reader io.Reader) (*string, error)
	UploadFile(metroCode, deviceTypeCode, processType, deviceManagementMode, licenseMode, fileName string, reader io.Reader) (*string, error)
	GetFile(uuid string) (*File, error)

	GetDeviceLinkGroups() ([]DeviceLinkGroup, error)
	GetDeviceLinkGroup(uuid string) (*DeviceLinkGroup, error)
	CreateDeviceLinkGroup(linkGroup DeviceLinkGroup) (*string, error)
	NewDeviceLinkGroupUpdateRequest(uuid string) DeviceLinkUpdateRequest
	DeleteDeviceLinkGroup(uuid string) error
}

// DeviceUpdateRequest describes composite request to update given Network Edge device
type DeviceUpdateRequest interface {
	WithDeviceName(deviceName string) DeviceUpdateRequest
	WithTermLength(termLength int) DeviceUpdateRequest
	WithNotifications(notifications []string) DeviceUpdateRequest
	WithCore(core int) DeviceUpdateRequest
	WithAdditionalBandwidth(additionalBandwidth int) DeviceUpdateRequest
	WithACLTemplate(templateID string) DeviceUpdateRequest
	WithMgmtAclTemplate(mgmtAclTemplateUuid string) DeviceUpdateRequest
	WithClusterName(clusterName string) DeviceUpdateRequest
	Execute() error
}

// SSHUserUpdateRequest describes composite request to update given Network Edge SSH user
type SSHUserUpdateRequest interface {
	WithNewPassword(password string) SSHUserUpdateRequest
	WithDeviceChange(old []string, new []string) SSHUserUpdateRequest
	Execute() error
}

// BGPUpdateRequest describes request to update given BGP configuration
type BGPUpdateRequest interface {
	WithLocalIPAddress(localIPAddress string) BGPUpdateRequest
	WithLocalASN(localASN int) BGPUpdateRequest
	WithRemoteASN(remoteASN int) BGPUpdateRequest
	WithRemoteIPAddress(remoteIPAddress string) BGPUpdateRequest
	WithAuthenticationKey(authenticationKey string) BGPUpdateRequest
	Execute() error
}

// DeviceLinkUpdateRequest descrobes request to update given Device Link Group
type DeviceLinkUpdateRequest interface {
	WithGroupName(name string) DeviceLinkUpdateRequest
	WithSubnet(subnet string) DeviceLinkUpdateRequest
	WithDevices(devices []DeviceLinkGroupDevice) DeviceLinkUpdateRequest
	WithLinks(links []DeviceLinkGroupLink) DeviceLinkUpdateRequest
	WithMetroLinks(metroLinks []DeviceLinkGroupMetroLink) DeviceLinkUpdateRequest
	WithRedundancyType(redundancyType string) DeviceLinkUpdateRequest
	Execute() error
}

// Error describes Network Edge error that occurs during API call processing
type Error struct {
	//ErrorCode is short error identifier
	ErrorCode string
	//ErrorMessage is textual description of an error
	ErrorMessage string
}

// ChangeError describes single error that occurred during update of selected target property
type ChangeError struct {
	Type   string
	Target string
	Value  interface{}
	Cause  error
}

func (e ChangeError) Error() string {
	return fmt.Sprintf("change type '%s', target '%s', value '%s', cause: '%s'", e.Type, e.Target, e.Value, e.Cause)
}

// UpdateError describes error that occurred during composite update request and consists of multiple atomic change errors
type UpdateError struct {
	Failed []ChangeError
}

// AddChangeError functions add new atomic change error to update error structure
func (e *UpdateError) AddChangeError(changeType string, target string, value interface{}, cause error) {
	e.Failed = append(e.Failed, ChangeError{
		Type:   changeType,
		Target: target,
		Value:  value,
		Cause:  cause})
}

// ChangeErrorsCount returns number of atomic change errors in a given composite update error
func (e UpdateError) ChangeErrorsCount() int {
	return len(e.Failed)
}

func (e UpdateError) Error() string {
	str := fmt.Sprintf("update error: %d changes failed.", len(e.Failed))
	for _, err := range e.Failed {
		str = fmt.Sprintf("%s [%s]", str, err.Error())
	}
	return str
}

// Account describes Network Edge customer account details
type Account struct {
	Name      *string
	Number    *string
	Status    *string
	UCMID     *string
	ProjectID *string
}

// Device describes Network Edge device
type Device struct {
	UUID                  *string
	Name                  *string
	TypeCode              *string
	Status                *string
	LicenseStatus         *string
	MetroCode             *string
	IBX                   *string
	Region                *string
	Throughput            *int
	ThroughputUnit        *string
	HostName              *string
	PackageCode           *string
	Version               *string
	IsBYOL                *bool
	LicenseToken          *string
	LicenseFile           *string
	CloudInitFile         *string
	LicenseFileID         *string
	CloudInitFileID       *string
	ACLTemplateUUID       *string
	MgmtAclTemplateUuid   *string
	SSHIPAddress          *string
	SSHIPFqdn             *string
	AccountNumber         *string
	Notifications         []string
	PurchaseOrderNumber   *string
	RedundancyType        *string
	RedundantUUID         *string
	TermLength            *int
	AdditionalBandwidth   *int
	OrderReference        *string
	InterfaceCount        *int
	CoreCount             *int
	IsSelfManaged         *bool
	Connectivity          *string
	WanInterfaceId        *string
	Interfaces            []DeviceInterface
	VendorConfiguration   map[string]string
	UserPublicKey         *DeviceUserPublicKey
	ASN                   *int
	ZoneCode              *string
	ClusterDetails        *ClusterDetails
	ProjectID             *string
	DiverseFromDeviceUUID *string
	DiverseFromDeviceName *string
	Tier                  *int
}

// DeviceInterface describes Network Edge device interface
type DeviceInterface struct {
	ID                *int
	Name              *string
	Status            *string
	OperationalStatus *string
	MACAddress        *string
	IPAddress         *string
	AssignedType      *string
	Type              *string
}

// DeviceUserPublicKey describes public SSH key along with username that is
// provisioned on a network device.
type DeviceUserPublicKey struct {
	Username *string
	KeyName  *string
}

// DeviceType describes Network Edge device type
type DeviceType struct {
	Name        *string
	Code        *string
	Description *string
	Vendor      *string
	Category    *string
	MetroCodes  []string
}

// DevicePlatform describes Network Edge platform configurations
// available for a given device type
type DevicePlatform struct {
	Flavor          *string
	CoreCount       *int
	Memory          *int
	MemoryUnit      *string
	PackageCodes    []string
	ManagementTypes []string
	LicenseOptions  []string
}

// DeviceSoftwareVersion describes available software packages and versions for a Network Edge device
type DeviceSoftwareVersion struct {
	Version          *string
	ImageName        *string
	Date             *string
	Status           *string
	IsStable         *bool
	ReleaseNotesLink *string
	PackageCodes     []string
}

// SSHUser describes Network Edge SSH user
type SSHUser struct {
	UUID        *string
	Username    *string
	Password    *string
	DeviceUUIDs []string
}

// BGPConfiguration describes Network Edge BGP configuration
type BGPConfiguration struct {
	UUID               *string
	ConnectionUUID     *string
	DeviceUUID         *string
	LocalIPAddress     *string
	LocalASN           *int
	RemoteIPAddress    *string
	RemoteASN          *int
	AuthenticationKey  *string
	State              *string
	ProvisioningStatus *string
}

// SSHPublicKey describes Network Edge SSH user public key
type SSHPublicKey struct {
	UUID      *string
	Name      *string
	Value     *string
	Type      *string
	ProjectID *string
}

// ACLTemplate describes Network Edge device ACL template
type ACLTemplate struct {
	UUID            *string
	Name            *string
	Description     *string
	DeviceUUID      *string // Deprecated: Refer to DeviceDetails for more information
	MetroCode       *string // Deprecated: Metro code is not required as template can be used for multiple devices across metros.
	DeviceACLStatus *string
	InboundRules    []ACLTemplateInboundRule
	DeviceDetails   []ACLTemplateDeviceDetails
	ProjectID       *string
}

// ACLTemplateInboundRule describes inbound ACL rule that is part of
// Network Edge device ACL template
type ACLTemplateInboundRule struct {
	SeqNo       *int
	FQDN        *string  // Deprecated: FQDN is no longer supported
	SrcType     *string  // Deprecated: SrcType is not required.
	Subnets     []string // Deprecated: Use subnet instead.
	Subnet      *string
	Protocol    *string
	SrcPort     *string
	DstPort     *string
	Description *string
}

// ACLTemplateDeviceDetails describes Device Details this template applied to
type ACLTemplateDeviceDetails struct {
	UUID      *string
	Name      *string
	ACLStatus *string
}

// DeviceAdditionalBandwidthDetails describes details of a device
// additional badwidth
type DeviceAdditionalBandwidthDetails struct {
	AdditionalBandwidth *int
	Status              *string
}

// DeviceACLDetails describes details of a device
// additional badwidth
type DeviceACLDetails struct {
	Status *string
}

// DeviceLinkGroup describes details of a device link group
type DeviceLinkGroup struct {
	UUID           *string
	Name           *string
	Subnet         *string
	ProjectID      *string
	Status         *string
	Devices        []DeviceLinkGroupDevice
	Links          []DeviceLinkGroupLink // Deprecated: Use MetroLinks instead
	MetroLinks     []DeviceLinkGroupMetroLink
	RedundancyType *string
}

// DeviceLinkGroupDevice describes details of a device within device
// link group
type DeviceLinkGroupDevice struct {
	DeviceID    *string
	ASN         *int
	InterfaceID *int
	Status      *string
	IPAddress   *string
}

// DeviceLinkGroupLink describes details if a link (connection) within
// device link group
type DeviceLinkGroupLink struct {
	AccountNumber        *string
	Throughput           *string
	ThroughputUnit       *string
	SourceMetroCode      *string
	DestinationMetroCode *string
	SourceZoneCode       *string
	DestinationZoneCode  *string
}

// DeviceLinkGroupMetroLink describes metro details and throughput
type DeviceLinkGroupMetroLink struct {
	AccountNumber  *string
	MetroCode      *string
	Throughput     *string
	ThroughputUnit *string
}

// ClusterDetails describes Network Edge cluster device details
type ClusterDetails struct {
	ClusterName        *string
	NumOfNodes         *int
	ClusterNodeDetails map[string]*ClusterNodeDetail // Deprecated: Use Node0 and Node1 instead
	ClusterId          *string
	Nodes              []ClusterNode // Deprecated: Use Node0 and Node1 instead
	Node0              *ClusterNodeDetail
	Node1              *ClusterNodeDetail
}

// ClusterNodeDetail describes Network Edge cluster node details
type ClusterNodeDetail struct {
	UUID                *string
	Name                *string
	VendorConfiguration map[string]string
	LicenseFileId       *string
	LicenseToken        *string
}

type ClusterNode struct { // Deprecated: Use ClusterNodeDetail instead
	UUID                *string
	Name                *string
	Node                *int
	AdminPassword       *string
	VendorConfiguration map[string]string
}

// File describes Network Edge uploaded file
type File struct {
	UUID           *string
	FileName       *string
	MetroCode      *string
	DeviceTypeCode *string
	ProcessType    *string
	Status         *string
}