# Packages
No description provided by the author
# Functions
DefaultPaging creates Paging with default settings (page 1, 50 records per page).
GetResourceDescription retrieves a textual description of the specified resource type.
ImageTypeName gets the name of the specified image type.
IsAPIError determines whether the specified error represents a CloudControl API error.
IsAPIErrorCode determines whether the specified error represents a CloudControl API error with the specified response code.
IsExceedsLimitError determines whether the specified error represents a EXCEEDS_LIMIT response (or its v1 equivalent, REASON_751) from CloudControl.
IsNoIPAddressAvailableError determines whether the specified error represents a NO_IP_ADDRESS_AVAILABLE response from CloudControl.
IsOperationCancelledError determines if an error is an OperationCancelledError.
IsResourceBusyError determines whether the specified error represents a RESOURCE_BUSY response (or its v1 equivalent, REASON_392) from CloudControl.
IsResourceNotFoundError determines whether the specified error represents a RESOURCE_NOT_FOUND response from CloudControl.
NewClient creates a new cloud compute API client.
NewClientWithBaseAddress creates a new cloud compute API client using a custom end-point base address.
# Constants
AssetTypeCustomerImage is an asset type of account.
AssetTypeCustomerImage is an asset type of customer image.
AssetTypeNetworkDomain is an asset type representing a network domain.
AssetTypePublicIPBlock is an asset type representing a public IP block.
AssetTypeServer is an asset type representing a server.
AssetTypeUser is an asset type representing a user.
AssetTypeVLAN is an asset type representing a virtual LAN (VLAN).
BackupClientStatusActive indicates that a backup client is currently contactable by Cloud Backup and is ready to service requests.
BackupClientStatusOffline indicates that a backup client is not currently contactable by Cloud Backup.
BackupClientStatusUnconfigured indicates that a backup client has not been configured by Cloud Backup.
BackupClientStatusUnregistered indicates that a backup client has never registered with Cloud Backup.
BackupServicePlanAdvanced represents the advanced service plan for Cloud Backup.
BackupServicePlanEnterprise represents the enterprise service plan for Cloud Backup.
BackupServicePlanEssentials represents the basic service plan for Cloud Backup.
FirewallRuleActionAccept indicates a firewall rule that, if it matches, will accept the packet and stop processing further rules.
FirewallRuleActionDrop indicates a firewale rule that, if it matches, will drop the packet.
FirewallRuleIPVersion4 indicates a firewall rule that targets IPv4.
FirewallRuleIPVersion6 indicates a firewale rule that targets IPv6.
FirewallRuleMatchAny indicates a firewall rule value that matches any other value in the same scope.
FirewallRuleProtocolICMP indicates a firewall rule that targets the Internet Control Message Protocol (ICMP).
FirewallRuleProtocolIP indicates a firewall rule that targets the Internet Protocol (IP).
FirewallRuleProtocolTCP indicates a firewall rule that targets the Transmission Control Protocol (TCP).
ImageTypeCustomer represents a customer image.
ImageTypeOS represents an OS (built-in) image.
ImageTypeUnknown represents an unknown image type.
FirewallRuleIPVersion4 indicates a firewall rule that targets IPv4.
FirewallRuleIPVersion6 indicates a firewale rule that targets IPv6.
LoadBalanceMethodLeastConnectionsMember indicates that requests will be directed to the pool node that has the smallest number of active connections at the moment of connection.
LoadBalanceMethodLeastConnectionsNode indicates that requests will be directed to the pool node that has the smallest number of active connections at the moment of connection.
LoadBalanceMethodObservedMember indicates that requests will be directed to the pool node that has the smallest number of active connections over time.
LoadBalanceMethodObservedNode indicates that requests will be directed to the pool node that has the smallest number of active connections over time.
LoadBalanceMethodPredictiveMember indicates that requests will be directed to the pool node that is predicted to have the smallest number of active connections over time.
LoadBalanceMethodPredictiveNode indicates that requests will be directed to the pool node that is predicted to have the smallest number of active connections.
LoadBalanceMethodRoundRobin indicates that requests will be directed to pool nodes in round-robin fashion.
NetworkAdapterTypeE1000 represents the E1000 network adapter type.
NetworkAdapterTypeE1000E represents the E1000e network adapter type.
NetworkAdapterTypeEnhancedVMXNET2 represents the VMXNET2/Enhanced network adapter type.
NetworkAdapterTypeFlexiblePCNET32 represents the PCNET32/Flexible network adapter type.
NetworkAdapterTypeVMXNET3 represents the VMXNET3 network adapter type.
ResourceStatusDeleted is a pseudo-status indicates that a resource has been deleted.
ResourceStatusNormal indicates that a resource is active.
ResourceStatusPendingAdd indicates that an add operation is pending for the resource.
ResourceStatusPendingChange indicates that a change operation is pending for the resource.
ResourceStatusPendingDelete indicates that a delete operation is pending for the resource.
ResourceTypeCustomerImage represents a customer image.
ResourceTypeFirewallRule represents a firewall rule.
ResourceTypeNetworkAdapter represents a network adapter in a virtual machine.
ResourceTypeNetworkDomain represents a network domain.
ResourceTypeOSImage represents an OS image.
ResourceTypePublicIPBlock represents a block of public IP addresses.
ResourceTypeServer represents a virtual machine.
ResourceTypeServerAntiAffinityRule represents a server anti-affinity rule.
ResourceTypeSSLCertificateChain represents an SSL certificate chain.
ResourceTypeSSLDomainCertificate represents an SSL certificate for a domain name.
ResourceTypeSSLOffloadProfile represents an SSL-offload profile.
ResourceStaticRoutes represents network domain static routes.
ResourceTypeVIPNode represents a VIP node.
ResourceTypeVIPPool represents a VIP pool.
ResourceTypeVirtualListener represents a virtual listener.
ResourceTypeVLAN represents a VLAN.
ResponseCodeAuthorizationFailure is a v2 API response code indicating that an operation failed because the caller was not authorised to perform that operation (e.g.
ResponseCodeExceedsLimit is a v2 API response code indicating that an operation failed because a resource limit was exceeded.
ResponseCodeInfrastructureInMaintenance is a v2 API response code indicating that an operation failed due to maintenance being performed on the supporting infrastructure.
ResponseCodeInProgress is a v2 API response code indicating that an operation is in progress.
ResponseCodeInvalidInputData is a v2 API response code indicating that an operation failed due to invalid input data.
ResponseCodeIPAddressNotUnique is a v2 API response code indicating that an operation failed due to the use of an IP address that duplicates an existing IP address.
ResponseCodeIPAddressOutOfRange is a v2 API response code indicating that an operation failed due to the use of an IP address lies outside the supported range (e.g.
ResponseCodeNoIPAddressAvailable is a v2 API response code indicating that there are no remaining unreserved IPv4 addresses in the target subnet.
ResponseCodeOK is a v2 API response code indicating that an operation completed successfully.
ResponseCodeOperationNotSupported is a v2 API response code indicating that an operation is not supported.
ResponseCodeOutOfResources is a v2 API response code indicating that an operation failed because some type of resource (e.g.
ResponseCodeResourceBusy is a v2 API response code indicating that an operation cannot be performed on a resource because the resource is busy.
ResponseCodeResourceHasDependency is a v2 API response code indicating that an operation cannot be performed on a resource because of a resource that depends on it.
ResponseCodeResourceLocked is a v2 API response code indicating that an operation cannot be performed on a resource because the resource is locked.
ResponseCodeResourceNameNotUnique is a v2 API response code indicating that an operation failed due to the use of a name that duplicates an existing name.
ResponseCodeResourceNotFound is a v2 API response code indicating that an operation failed because a target resource was not found.
ResponseCodeUnexpectedError is a v2 API response code indicating that the CloudControl API encountered an unexpected error.
ResultCodeBackupClientNotFound is a v1 API result code indicating that an operation cannot be performed on a backup client because the backup client does not exist (or was never actually installed on the target server).
ResultCodeBackupEnabledForServer is a v1 API result code indicating that an operation cannot be performed on a server because backup is enabled for that server.
ResultCodeBackupEnablementInProgressForServer is a v1 API result code indicating that an operation cannot be performed on a server because backup is in the process of being enabled for that server.
ResultCodeBackupJobInProgress is a v1 API result code indicating that an operation cannot be performed on a server because one or more backup jobs are in progress for that server.
Backup service is not enabled for organisation.
Backup service is not enabled for org at the datacenter where server resides.
ResultCodeBackupNotEnabledForServer is a v1 API result code indicating that an operation cannot be performed on a server because backup is not enabled for that server.
ResultCodeExceedsLimit is a v1 API result code indicating that an operation cannot be performed on a resource because a resource limit was exceeded.
ResultCodeResourceBusy is a v1 API result code indicating that an operation cannot be performed on a resource because the resource is busy.
ResultCodeServerHasBackupAgents is a v1 API result code indicating that an operation cannot be performed on a server because the server still has one or more backup agents assigned to it.
ResultCodeServerNotFound is a v1 API result code indicating that an operation cannot be performed on a server because the server could not be found.
ResultCodeSuccess is a v1 API result code indicating that an operation completed successfully.
ResultSuccess is a v1 API result indicating that an operation completed successfully.
ServerDiskSpeedEconomy represents the economy speed for server disks.
ServerDiskSpeedHighPerformance represents the high-performance speed for server disks.
Provisioned IOPS.
ServerDiskSpeedStandard represents the standard speed for server disks.
ServiceDownActionDrop indicates that a pool service will be dropped when it is down.
ServiceDownActionNone indicates no action will be taken when a pool service is down.
ServiceDownActionReselect indicates that a pool service will be reselected when it is down.
Source port preservation is disabled.
Source port preservation is enabled.
Source port preservation is enabled (strict mode).
StorageControllerAdapterTypeBusLogicParallel represents the BusLogic Parallel storage controller adapter type.
StorageControllerAdapterTypeEnhancedVMWareParavirtual represents the VMWare Paravirtual storage controller adapter type.
StorageControllerAdapterTypeLSILogicParallel represents the LSI Logic Parallel storage controller adapter type.
StorageControllerAdapterTypeLSILogicSAS represents the LSI Logic SAS storage controller adapter type.
VIPNodeStatusDisabled represents a VIP node that is currently disabled.
VIPNodeStatusEnabled represents a VIP node that is currently enabled.
VIPNodeStatusForcedOffline represents a VIP node that has been forced offline.
Any protocol (as supported by a high-performance layer 4 virtual listener).
Hypertext Transfer Protocol (as supported by a high-performance layer 4 virtual listener).
Transmission Control Protocol (as supported by a high-performance layer 4 virtual listener).
Uniform Datagram Protocol (as supported by a high-performance layer 4 virtual listener).
Any protocol (as supported by a standard virtual listener).
File Transfer Protocol (as supported by a standard virtual listener).
Hypertext Transfer Protocol (as supported by a standard virtual listener).
Simple Mail Transfer Protocol (as supported by a standard virtual listener).
Transmission Control Protocol (as supported by a standard virtual listener).
Uniform Datagram Protocol (as supported by a standard virtual listener).
VirtualListenerTypePerformanceLayer4 represents a high-performance (layer 4) virtual listener.
VirtualListenerTypeStandard represents a standard virtual listener.
# Structs
Account represents the details for a compute account.
APIError is an error representing an error response from an API.
APIResponseAdditionalInformationV1 represents additional information in a V1 API response (in the form of a name / value pair).
APIResponseV1 represents a response from the CloudControl v1 API for an asynchronous operation.
APIResponseV2 represents the basic response most commonly received when making v2 API calls.
No description provided by the author
BackupClientAlerting represents the alerting configuration for a backup client.
BackupClientDetail represents the detail for a specific backup client on a server.
BackupClientType represents a types of backup client enabled for a server.
BackupClientTypes represents the types of backup client enabled for a server.
BackupSchedulePolicies represents a list of backup schedule policies.
BackupSchedulePolicy represents a Cloud Backup schedule policy.
BackupStoragePolicies represents a list of backup storage policies.
BackupStoragePolicy represents a Cloud Backup storage policy.
Client is the client for Dimension Data's cloud compute API.
Request body for creating a Static Route.
CustomerImage represents a custom virtual machine image.
CustomerImages represents a page of CustomerImage results.
Datacenter represents an MCP datacenter.
DatacenterNetworking represents the networking configuration for an MCP datacenter.
Datacenters represents the response to a "List Datacenters" API call.
DeleteVLAN represents a request to delete a compute VLAN.
DeployVLAN represents the request body when deploying a cloud compute VLAN.
DeployVLAN represents the request body when deploying a cloud compute VLAN.
No description provided by the author
EditIPAddressList represents the request body for editing an IP address list.
EditPortList represents the request body for editing a port list.
EditVIPNodeConfiguration represents the request body when editing a VIP node.
EditVIPPoolConfiguration represents the request body when editing a VIP pool.
EditVirtualListenerConfiguration represents the configuration for editing a virtual listener.
EditVLAN represents the request body when editing a cloud compute VLAN.
EntityReference is used to group an entity Id and name together for serialisation / deserialisation purposes.
FieldMessage represents a field name together with an associated message.
FirewallRule represents a firewall rule.
FirewallRuleConfiguration represents the configuration for a new firewall rule.
FirewallRuleIPAddress represents represents an IP address for firewall configuration.
FirewallRulePlacement describes the placement for a firewall rule.
FirewallRulePort represents a firewall port configuration.
FirewallRules represents a page of FirewallRule results.
FirewallRuleScope represents a scope (IP and / or port) for firewall configuration (source or destination).
HealthMonitor represents a load-balancer persistence (stickiness) profile.
HealthMonitors represents a page of HealthMonitor results.
ImageGuestInformation represents guest-related information about a virtual machine image.
IPAddressList represents an IP address list.
IPAddressListEntry represents an entry in an IP address list.
IPAddressLists represents a page of IPAddressList results.
IPv4Range represents an IPv4 network (base address and prefix size).
IPv6Range represents an IPv6 network (base address and prefix size).
IRule represents a load-balancer iRule.
IRules represents a page of IRule results.
NATRule represents a Network Address Translation (NAT) rule.
NATRules represents a page of NATRule results.
NetworkDomain represents a compute network domain.
NetworkDomains represents the response to a "List Network Domains" API call.
NewVIPNodeConfiguration represents the configuration for a new VIP node.
NewVIPPoolConfiguration represents the configuration for a new VIP pool.
NewVirtualListenerConfiguration represents the configuration for a new virtual listener.
OperatingSystem represents a well-known operating system for virtual machines.
OperationCancelledError is the error returned when an operation cancelled.
OSImage represents a DD-provided virtual machine image.
OSImages represents a page of OSImage results.
PagedResult represents the common fields for all paged results from the compute API.
Paging contains the paging configuration for a compute API operation.
PersistenceProfile represents a load-balancer persistence (stickiness) profile.
PersistenceProfiles represents a page of PersistenceProfile results.
PortList represents a port list.
PortListEntry represents an entry in a port list.
PortLists represents a page of PortList results.
PublicIPBlock represents an allocated block of public IPv4 addresses.
PublicIPBlocks represents a page of PublicIPBlock results.
Request body when reserving an IP address.
ReservedIPv4Addresses represents a page of ReservedIPAddress results for reserved IPv4 addresses.
ReservedIPv6Addresses represents a page of ReservedIPAddress results for reserved IPv6 addresses.
ReservedPublicIP represents a public IPv4 address reserved for NAT or a VIP.
ReservedPublicIPs represents a page of ReservedPublicIP results.
Role represents a role assigned to a compute account.
Server represents a virtual machine.
ServerAntiAffinityRule represents an anti-affinity rule between 2 servers.
ServerAntiAffinityRules represents a page of ServerAntiAffinityRule results.
ServerBackup represents the backup configuration for a server.
ServerBackupDetails represents detailed backup information for a server.
ServerDeploymentConfiguration represents the configuration for deploying a virtual machine.
Servers represents a page of Server results.
ServerSummary respresents summary information for a server.
SSLCertificateChain represents an SSL certificate applicable to a domain name.
SSLCertificateChains represents a page of SSLCertificateChain results.
SSLDomainCertificate represents an SSL certificate applicable to a domain name.
SSLDomainCertificates represents a page of SSLDomainCertificate results.
SSLOffloadProfile represents an SSL-offload profile.
SSLOffloadProfiles represents a page of SSLOffloadProfile results.
StaticRoute reporesents client static route on a network domain in an MCP2 data center.
No description provided by the author
Tag represents a tag applied to an asset.
TagDetail represents detailed information about a tag applied to an asset.
TagDetails represents a page of TagDetail results.
TagKey represents a key for asset tags.
TagKeys represents a page of TagKey results.
UncustomizedServerDeploymentConfiguration represents the configuration for deploying a virtual machine without guest OS customisation.
VIPNode represents a VIP node.
VIPNodeHealthMonitor represents a health Monitor to a VIP node.
VIPNodeReference represents a reference to a VIP node.
VIPNodes represents a page of VIPNode results.
VIPPool represents a VIP pool.
VIPPoolMember represents a combination of node and port as a member of a VIP pool.
VIPPoolMembers represents a page of VIPPoolMember results.
VIPPools represents a page of VIPPool results.
VirtualListener represents a virtual listener.
VirtualListeners represents a page of VirtualListener results.
VirtualListenerVIPPoolRef represents a VirtualListener's reference to a VIP pool.
VirtualMachineCPU represents the CPU configuration for a virtual machine.
VirtualMachineDisk represents the configuration for disk in a virtual machine.
VirtualMachineNetwork represents the networking configuration for a virtual machine.
VirtualMachineNetworkAdapter represents the configuration for a virtual machine's network adapter.
VirtualMachineSCSIController represents the configuration for a SCSI controller in a virtual machine.
VLAN represents a compute VLAN.
VLANs represents the response to a "List VLANs" API call.
# Interfaces
APIResponse represents the response to an API call.
Entity represents a Cloud Control entity.
Image represents an image used to create servers.
IPRange represents an IPvX range.
NamedEntity represents a named Cloud Control entity.
Resource represents a compute resource.
# Type aliases
ImageType represents a type of Image.
ResourceType represents a well-known DD compute resource type.
VirtualMachineDisks is an array of VirtualMachineDisk that adds convenience methods.
VirtualMachineSCSIControllers is an array of VirtualMachineSCSIController that adds various convenience methods.