# README
Go lang package for OnApp Cloud Platform
Maintainers
This OnApp Go is maintained by:
- The Taras Brodovych at Virtuozzo
Requirements
- Go 1.20.x or higher
Developing the OnApp Go
If you wish to work on the OnApp Go, you'll first need Go installed on your machine (version 1.20.x is required).
You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.
# Packages
Package version provides a location to set the release versions for all packages to consume, without creating import cycles.
# Functions
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
DoRequest submits an HTTP request.
DoRequestWithClient submits an HTTP request using the specified client.
Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.
No description provided by the author
New returns a new OnApp API client instance.
NewClient returns a new OnApp API client.
No description provided by the author
ServerTypesRestrictions -.
SetAllowUnverifiedSSL is a client option for setting allowUnverifiedSSL.
SetBaseURL is a client option for setting the base URL.
SetBasicAuth is a client option for setting the user and password for API call.
SetUserAgent is a client option for setting the user agent.
StreamToString converts a reader to a string.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
StringInSlice -.
# Constants
"accelerated_server".
ResourceRoots.
"allocation_pool".
"allocation_vapp".
"application_server".
ResourceRoots.
No description provided by the author
No description provided by the author
No description provided by the author
"autoscaled_server".
ResourceRoots.
"backup_resource_usage".
ResourceRoots.
"backup_server_zone".
ResourceRoots.
ResourceRoots.
ServerTypes.
ResourceRoots.
"baremetal_server".
ResourceRoots.
"cdn".
ResourceRoots.
ResourceRoots.
"compute_zone".
ResourceRoots.
"container_server".
ResourceRoots.
"data_store_zone".
ResourceRoots.
No description provided by the author
"draas".
ResourceRoots.
"edge_group".
ResourceRoots.
"external_networking".
No description provided by the author
No description provided by the author
No description provided by the author
"hypervisor_storing".
ServerTypes.
"instance_package".
"iso_template".
ResourceRoots.
No description provided by the author
No description provided by the author
No description provided by the author
"network_zone".
ResourceRoots.
"networking".
ServerTypes.
powered_on = false.
powered_on = true.
any state of powered_on.
ResourceRoots.
ServerTypes.
"ova_template".
"preconfigured_server".
ResourceRoots.
No description provided by the author
"recipe".
"recipe_group".
ResourceRoots.
"recovery_point_on_backup_resource".
"regular_backup_on_backup_server".
"regular_backup_on_hypervisor".
"regular_server".
"regular_template_on_backup_server".
"regular_template_on_hypervisor".
"reservation_pool".
"service_addon".
"service_addon_group".
ResourceRoots.
ResourceRoots.
ServerTypes.
"smart_server".
ResourceRoots.
ResourceRoots.
"solidfire_storing".
"storing".
"subscription".
"sum_of_hourly_adjustment".
"sum_of_hourly_stat".
"sum_of_hourly_stat_archived".
"sum_of_hourly_stat_non_archived".
ServerTypes.
"template_group".
ResourceRoots.
ResourceRoots.
"template_usage".
ResourceRoots.
TransactionCancelled is a cancelled transaction status.
TransactionComplete is a completed transaction status.
TransactionFailed is a failed transaction status.
TransactionPending is a pending transaction status.
TransactionRunning is a running transaction status.
No description provided by the author
"vdc_storing".
ServerTypes.
"virtual_server".
ResourceRoots.
ServerTypes.
"vpc_server".
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
AccessControlsServiceOp handles communication with the AccessControl related methods of the OnApp API.
AccountAttributes - SolidFire account username.
AdditionalFields -.
No description provided by the author
AdvancedOptions -.
No description provided by the author
AssignIPAddress - used for assign IPAddress to the VirtualMachine or User.
AttachDiskHardwareDevice represents a request to attach disks from hypervisor to the integrated data store.
AttachNetworkInterfaceHardwareDevice represents a request to attach network interfaces from hypervisor to the integrated data store.
No description provided by the author
Backup represent VirtualMachine backup.
BackupCreateRequest - data for creating Backup.
BackupNoteRequest - data for add/edit backup note.
BackupResource represents a BackupResource.
BackupResourceCreateRequest represents a request to create a BackupResource.
BackupResourcesServiceOp handles communication with the Backup Resource related methods of the OnApp API.
BackupResourceZone represents a BackupResourceZone.
BackupResourceZoneCreateRequest represents a request to create a BackupResourceZone.
BackupResourceZonesServiceOp handles communication with the Backup Resource Zone related methods of the OnApp API.
BackupServer - represent a backup server of OnApp API.
BackupServerCreateRequest represents a request to create a BackupServer.
BackupServerEditRequest represents a request to edit a BackupServer.
BackupServerGroup represents a BackupServerGroup.
BackupServerGroupCreateRequest represents a request to create a BackupServerGroup.
BackupServerGroupEditRequest represents a request to edit a BackupServerGroup.
BackupServerGroupsServiceOp handles communication with the Backup Server Group related methods of the OnApp API.
BackupServerJoin represents a BackupServerJoin.
BackupServerJoinCreateRequest represents a request to create a BackupServerJoin.
BackupServerJoinDeleteRequest represents a request to delete a BackupServerJoin.
BackupServerJoinsServiceOp -.
BackupServersServiceOp handles communication with the Backup Server related methods of the OnApp API.
BackupsServiceOp handles communication with the Backup related methods of the OnApp API.
Bucket -.
BucketCreateRequest -.
BucketsServiceOp handles communication with the Bucket related methods of the OnApp API.
Certificate -.
Certificates -.
No description provided by the author
Client manages communication with OnApp API.
No description provided by the author
CloudbootComputeResourceEditRequest represents a request to edit a CloudbootComputeResource.
CloudbootComputeResourcesServiceOp handles communication with the CloudbootComputeResource related methods of the OnApp API.
No description provided by the author
No description provided by the author
CloudbootIPAddressesServiceOp handles communication with the CloudbootIPAddress related methods of the OnApp API.
Configuration - represent configuration settings of OnApp installation.
ConfigurationsServiceOp handles communication with the Configuration related methods of the OnApp API.
ConnectionOptions for VMware hypervisor.
ConvertBackupToTemplateRequest - data for converting Backup to the Template.
CustomRecipeVariableAttributes -.
DataStore represents a DataStore.
DataStoreCreateRequest represents a request to create a DataStore.
DataStoreEditRequest represents a request to edit a DataStore.
DataStoreGroup represents a DataStoreGroup.
DataStoreGroupCreateRequest represents a request to create a DataStoreGroup.
DataStoreGroupEditRequest represents a request to edit a DataStoreGroup.
DataStoreGroupsServiceOp handles communication with the Data Store Groups related methods of the OnApp API.
DataStoreJoin represents a DataStoreJoin.
DataStoreJoinCreateRequest represents a request to create a DataStoreJoin.
DataStoreJoinDeleteRequest represents a request to delete a DataStoreJoin.
DataStoreJoinsServiceOp -.
DataStoreSolidFireCreateRequest represents a request to create a SolidFire DataStore.
DataStoresServiceOp handles communication with the Data Store related methods of the OnApp API.
DataStoreZonePricing -.
Disk - represent disk from Virtual Machine.
DiskCreateRequest - data for creating Disk.
DiskEditRequest - data for editing Disk.
DisksServiceOp handles communication with the Disk related methods of the OnApp API.
No description provided by the author
EnginesServiceOp handles communication with the Engine related methods of the OnApp API.
An ErrorResponse reports the error caused by an API request.
FirewallRule - https://docs.onapp.com/apim/latest/firewall-rules-for-vss.
FirewallRuleCreateRequest represents a request to create a FirewallRule.
FirewallRulesServiceOp handles communication with the FirewallRules related methods of the OnApp API.
HardwareCustomDevice -.
HardwareDevices -.
HardwareDiskDevice -.
HardwareDiskPciDevice -.
HardwareNetworkInterfaceDevice -.
Hypervisor represent Hypervisor of the OnApp API.
HypervisorCreateRequest represents a request to create a Hypervisor.
HypervisorEditRequest represents a request to edit a Hypervisor.
HypervisorGroup represent Compute Zone of the OnApp API.
HypervisorGroupCreateRequest represents a request to create a Compute Zone.
HypervisorGroupEditRequest represents a request to edit a Compute Zone.
HypervisorGroupsServiceOp handles communication with the Compute Zone related methods of the OnApp API.
HypervisorRebootRequest -.
HypervisorsServiceOp handles communication with the Hypervisor related methods of the OnApp API.
HypervisorZone -.
HypervisorZonePricing -.
HypervisorZonesServiceOp handles communication with the HypervisorZone related methods of the OnApp API.
ID -.
ImageTemplate - represent a template of OnApp API from cloud.
ImageTemplateCreateRequest represents a request to install template.
ImageTemplateEditRequest represents a request to edit template.
ImageTemplateGroup - represent a template of OnApp API.
ImageTemplateGroupAttachRequest represents a request to attach template to the ImageTemplateGroup.
ImageTemplateGroupCreateRequest represents a request to create a ImageTemplateGroup.
ImageTemplateGroupEditRequest represents a request to edit a ImageTemplateGroup.
ImageTemplateGroupsServiceOp handles communication with the ImageTemplateGroup related methods of the OnApp API.
ImageTemplatesServiceOp handles communication with the ImageTemplate related methods of the OnApp API.
Infoboxes -.
InstancePackage represents a InstancePackage.
InstancePackageCreateRequest represents a request to create a InstancePackage.
InstancePackagesServiceOp handles communication with the Instance Package related methods of the OnApp API.
IntegratedDataStoreCreateRequest represents a request to create a IntegrateDataStores.
No description provided by the author
IntegratedDataStoresServiceOp handles communication with the Data Store related methods of the OnApp API.
IntegratedStorageCacheSettings -.
IntegratedStorageSettings -.
IoLimits -.
IPAddress -.
IPAddresses -.
IPAddressesJoin -.
IPAddressesServiceOp handles communication with the IPAddresses related methods of the OnApp API.
IPAddressJoin -.
IPNet -.
IPNetCreateRequest -.
IPNetEditRequest -.
IPNetsServiceOp handles communication with the IPNet related methods of the OnApp API.
IPRange -.
IPRangeCreateRequest -.
IPRangesServiceOp handles communication with the IPRange related methods of the OnApp API.
No description provided by the author
No description provided by the author
LicensesServiceOp handles communication with the License related methods of the OnApp API.
Links manages links that are returned along with a List.
ListOptions specifies the optional parameters to various List methods that support pagination.
LocationGroup represent LocationGroup from OnApp API.
LocationGroupCreateRequest represents a request to create a LocationGroup.
LocationGroupsServiceOp handles communication with the LocationGroup related methods of the OnApp API.
Network represents a Network.
NetworkCreateRequest represents a request to create a Network.
NetworkEditRequest represents a request to edit a Network.
NetworkGroup represents a NetworkGroup.
NetworkGroupCreateRequest represents a request to create a NetworkGroup.
NetworkGroupEditRequest represents a request to edit a NetworkGroup.
NetworkGroupsServiceOp handles communication with the NetworkGroups related methods of the OnApp API.
NetworkInterface represents a NetworkInterface.
NetworkInterfaceCreateRequest represents a request to create a NetworkInterface.
NetworkInterfaceEditRequest represents a request to edit a NetworkInterface.
NetworkInterfacesServiceOp handles communication with the NetworkInterfaces related methods of the OnApp API.
NetworkJoin represents a NetworkJoin.
NetworkJoinCreateRequest represents a request to create a NetworkJoin.
NetworkJoinDeleteRequest represents a request to delete a NetworkJoin.
NetworkJoinsServiceOp -.
NetworksServiceOp handles communication with the Networks related methods of the OnApp API.
NetworkZonePricing -.
No description provided by the author
No description provided by the author
Permission -.
Permissions -.
No description provided by the author
No description provided by the author
RateCardsServiceOp handles communication with the RateCard related methods of the OnApp API.
Recipe represents a Recipe.
RecipeCreateRequest represents a request to create a Recipe.
RecipeGroup represents a RecipeGroup.
No description provided by the author
RecipeGroupCreateRequest represents a request to create a RecipeGroup.
RecipeGroupEditRequest represents a request to edit a RecipeGroup.
RecipeGroupsServiceOp handles communication with the RecipeGroups related methods of the OnApp API.
RecipeJoin represents a RecipeJoin.
RecipeJoinCreateRequest represents a request to create a ControlPanel RecipeJoin.
RecipeJoinDeleteRequest represents a request to delete a RecipeJoin.
RecipeJoinsServiceOp -.
RecipesServiceOp handles communication with the Data Store related methods of the OnApp API.
No description provided by the author
RecipeStepCreateRequest represents a request to create a RecipeStep.
No description provided by the author
RecipeStepsServiceOp handles communication with the Data Store related methods of the OnApp API.
No description provided by the author
RemoteTemplate - represent a template of OnApp API from repository.
RemoteTemplatesServiceOp handles communication with the RemoteTemplate related methods of the OnApp API.
Resolver - https://docs.onapp.com/apim/latest/resolvers.
ResolverCreateRequest represents a request to create a Resolver.
ResolversServiceOp handles communication with the Resolvers related methods of the OnApp API.
Response is a OnApp response.
Role -.
RoleCreateRequest represents a request to create a Role.
Roles -.
RolesServiceOp handles communication with the Roles related methods of the OnApp API.
SoftwareLicense - represent disk from Virtual Machine.
SoftwareLicenseCreateRequest - data for creating SoftwareLicense.
SoftwareLicensesServiceOp handles communication with the SoftwareLicense related methods of the OnApp API.
SSHKey - represent disk from Virtual Machine.
SSHKeyCreateRequest - data for creating SSHKey.
SSHKeyEditRequest - data for editing SSHKey.
SSHKeysServiceOp handles communication with the SSHKey related methods of the OnApp API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TierOptions -.
Transaction represents a OnApp Transaction.
TransactionsServiceOp handles communition with the image action related methods of the OnApp API.
UnAssignIPAddressRequest -.
User -.
UserBucket -.
UserBuckets -.
UserCreateRequest -.
UserDeleteRequest -.
UserEditRequest -.
UserGroup -.
UserGroupCreateRequest -.
UserGroupEditRequest -.
UserGroupsServiceOp handles communication with the UserGroup related methods of the OnApp API.
UsersServiceOp handles communication with the User related methods of the OnApp API.
UserVirtualServerPricing -.
UserWhiteList represents a UserWhiteList.
UserWhiteListCreateRequest represents a request to create a UserWhiteList.
UserWhiteListsServiceOp handles communication with the UserWhiteLists related methods of the OnApp API.
VirtualMachine represent VirtualServer from OnApp API.
VirtualMachineActionsServiceOp handles communication with the VirtualMachine action related methods of the OnApp API.
VirtualMachineCreateRequest represents a request to create a VirtualMachine.
VirtualMachineRestartRequest -.
VirtualMachinesServiceOp handles communication with the VirtualMachine related methods of the OnApp API.
# Interfaces
AccessControlsService is an interface for interfacing with the AccessControls endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/buckets/access-control.
BackupResourcesService is an interface for interfacing with the Backup Resources endpoints of the OnApp API https://docs.onapp.com/apim/latest/backup-resources.
BackupResourceZonesService is an interface for interfacing with the Backup Resource Zones endpoints of the OnApp API https://docs.onapp.com/apim/latest/backup-server-zones.
BackupServerGroupsService is an interface for interfacing with the Backup Server Groups endpoints of the OnApp API https://docs.onapp.com/apim/latest/backup-resource-zones.
BackupServerJoinsService is an interface for interfacing with the BackupServerJoin.
BackupServersService is an interface for interfacing with the Backup Server endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/backup-servers.
BackupsService is an interface for interfacing with the Backup endpoints of the OnApp API https://docs.onapp.com/apim/latest/backups-snapshots.
BucketsService is an interface for interfacing with the Bucket endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/buckets.
CloudbootComputeResourcesService is an interface for interfacing with the CloudbootComputeResource endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/compute-resources.
CloudbootIPAddressesService is an interface for interfacing with the CloudbootIPAddress endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/cloudboot-ip-addresses.
ConfigurationsService is an interface for interfacing with the Configurations endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/system-configuration.
DataStoreGroupsService is an interface for interfacing with the Data Store Zones endpoints of the OnApp API https://docs.onapp.com/apim/latest/data-store-zones.
DataStoreJoinsService is an interface for interfacing with the DataStoreJoin.
DataStoresService is an interface for interfacing with the DataStore endpoints of the OnApp API https://docs.onapp.com/apim/latest/data-stores.
DisksService is an interface for interfacing with the Disk endpoints of the OnApp API https://docs.onapp.com/apim/latest/disks.
EnginesService is an interface for interfacing with the Engines endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/onapp-engine.
FirewallRulesService is an interface for interfacing with the FirewallRule endpoints of the OnApp API https://docs.onapp.com/apim/latest/firewall-rules-for-vss.
HypervisorGroupsService is an interface for interfacing with the Compute Zone endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/compute-zones.
HypervisorsService is an interface for interfacing with the Hypervisor endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/compute-resources.
HypervisorZonesService is an interface for interfacing with the HypervisorZone endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/federation/get-list-of-federated-resources.
ImageTemplateGroupsService is an interface for interfacing with the ImageTemplateGroup endpoints of the OnApp API https://docs.onapp.com/apim/latest/template-store.
ImageTemplatesService is an interface for interfacing with the ImageTemplate endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/templates
Describe templates *installed* on the OnApp cloud.
InstancePackagesService is an interface for interfacing with the Instance Packages endpoints of the OnApp API https://docs.onapp.com/apim/latest/instance-packages.
IntegratedDataStoresService is an interface for interfacing with the IntegrateDataStores endpoints of the OnApp API https://docs.onapp.com/apim/latest/integrated-storage.
IPAddressesService is an interface for interfacing with the IPAddress endpoints of the OnApp API https://docs.onapp.com/apim/latest/ip-addresses.
IPNetsService is an interface for interfacing with the IPNet endpoints of the OnApp API https://docs.onapp.com/apim/latest/ip-nets.
IPRangesService is an interface for interfacing with the IPRange endpoints of the OnApp API https://docs.onapp.com/apim/latest/ip-ranges.
LicensesService is an interface for interfacing with the Licenses endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/buckets/access-control.
LocationGroupsService is an interface for interfacing with the LocationGroup endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/location-groups.
NetworkGroupsService is an interface for interfacing with the NetworkGroup endpoints of the OnApp API https://docs.onapp.com/apim/latest/network-zones.
NetworkInterfacesService is an interface for interfacing with the NetworkInterface endpoints of the OnApp API https://docs.onapp.com/apim/latest/network-interfaces.
NetworkJoinsService is an interface for interfacing with the NetworkJoin.
NetworksService is an interface for interfacing with the Network endpoints of the OnApp API https://docs.onapp.com/apim/latest/networks.
RateCardsService is an interface for interfacing with the RateCard endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/buckets/rate-card.
RecipeGroupsService is an interface for interfacing with the RecipeGroup endpoints of the OnApp API https://docs.onapp.com/apim/latest/recipe_group-groups.
RecipeJoinsService is an interface for interfacing with the RecipeJoin.
RecipesService is an interface for interfacing with the Recipe endpoints of the OnApp API https://docs.onapp.com/apim/latest/recipes.
RecipeStepsService is an interface for interfacing with the RecipeStep endpoints of the OnApp API https://docs.onapp.com/apim/latest/recipes/manage-recipe-steps.
RemoteTemplatesService is an interface for interfacing with the RemoteTemplate endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/templates/get-list-of-available-for-installation-templates
Describe templates *available* for install on the OnApp repository.
ResolversService is an interface for interfacing with the Resolver endpoints of the OnApp API https://docs.onapp.com/apim/latest/firewall-rules-for-vss.
RolesService is an interface for interfacing with the Role endpoints of the OnApp API https://docs.onapp.com/apim/latest/roles.
SoftwareLicensesService is an interface for interfacing with the SoftwareLicense endpoints of the OnApp API https://docs.onapp.com/apim/latest/software-licenses.
SSHKeysService is an interface for interfacing with the SSHKey endpoints of the OnApp API https://docs.onapp.com/apim/latest/ssh-keys.
TransactionsService handles communction with action related methods of the OnApp API: https://docs.onapp.com/apim/latest/transactions.
UserGroupsService is an interface for interfacing with the UserGroup endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/user-groups.
UsersService is an interface for interfacing with the User endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/users.
UserWhiteListsService is an interface for interfacing with the UserWhiteList endpoints of the OnApp API https://docs.onapp.com/apim/latest/whitelist-ips.
VirtualMachineActionsService is an interface for interfacing with the VirtualMachine actions endpoints of the OnApp API.
VirtualMachinesService is an interface for interfacing with the VirtualMachine endpoints of the OnApp API See: https://docs.onapp.com/apim/latest/virtual-servers.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
ActionRequest reprents OnApp Action Request.
No description provided by the author
No description provided by the author
ClientOpt are options for New.
No description provided by the author
No description provided by the author
IntegratedDataStoresEditRequest represents a request to edit a IntegrateDataStores.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RequestCompletionCallback defines the type of the request callback function.
SoftwareLicenseEditRequest - data for editing SoftwareLicense.
No description provided by the author
UserWhiteListEditRequest represents a request to edit a UserWhiteList.