Module: Ionoscloud

Defined in:
lib/ionoscloud/version.rb,
lib/ionoscloud.rb,
lib/ionoscloud/api/_api.rb,
lib/ionoscloud/api_error.rb,
lib/ionoscloud/api_client.rb,
lib/ionoscloud/models/lan.rb,
lib/ionoscloud/models/nic.rb,
lib/ionoscloud/models/info.rb,
lib/ionoscloud/models/lans.rb,
lib/ionoscloud/models/nics.rb,
lib/ionoscloud/models/peer.rb,
lib/ionoscloud/models/type.rb,
lib/ionoscloud/models/user.rb,
lib/ionoscloud/api/lans_api.rb,
lib/ionoscloud/models/error.rb,
lib/ionoscloud/models/group.rb,
lib/ionoscloud/models/image.rb,
lib/ionoscloud/models/label.rb,
lib/ionoscloud/models/token.rb,
lib/ionoscloud/models/users.rb,
lib/ionoscloud/configuration.rb,
lib/ionoscloud/models/cdroms.rb,
lib/ionoscloud/models/groups.rb,
lib/ionoscloud/models/images.rb,
lib/ionoscloud/models/labels.rb,
lib/ionoscloud/models/s3_key.rb,
lib/ionoscloud/models/server.rb,
lib/ionoscloud/models/volume.rb,
lib/ionoscloud/api/images_api.rb,
lib/ionoscloud/api/labels_api.rb,
lib/ionoscloud/models/nic_put.rb,
lib/ionoscloud/models/request.rb,
lib/ionoscloud/models/s3_keys.rb,
lib/ionoscloud/models/servers.rb,
lib/ionoscloud/models/volumes.rb,
lib/ionoscloud/api/servers_api.rb,
lib/ionoscloud/api/volumes_api.rb,
lib/ionoscloud/models/contract.rb,
lib/ionoscloud/models/flow_log.rb,
lib/ionoscloud/models/ip_block.rb,
lib/ionoscloud/models/lan_nics.rb,
lib/ionoscloud/models/lan_post.rb,
lib/ionoscloud/models/location.rb,
lib/ionoscloud/models/requests.rb,
lib/ionoscloud/models/resource.rb,
lib/ionoscloud/models/snapshot.rb,
lib/ionoscloud/models/template.rb,
lib/ionoscloud/models/user_put.rb,
lib/ionoscloud/api/requests_api.rb,
lib/ionoscloud/models/contracts.rb,
lib/ionoscloud/models/flow_logs.rb,
lib/ionoscloud/models/ip_blocks.rb,
lib/ionoscloud/models/locations.rb,
lib/ionoscloud/models/resources.rb,
lib/ionoscloud/models/s3_bucket.rb,
lib/ionoscloud/models/snapshots.rb,
lib/ionoscloud/models/templates.rb,
lib/ionoscloud/models/user_post.rb,
lib/ionoscloud/api/flow_logs_api.rb,
lib/ionoscloud/api/ip_blocks_api.rb,
lib/ionoscloud/api/locations_api.rb,
lib/ionoscloud/api/snapshots_api.rb,
lib/ionoscloud/api/templates_api.rb,
lib/ionoscloud/models/datacenter.rb,
lib/ionoscloud/api/kubernetes_api.rb,
lib/ionoscloud/models/backup_unit.rb,
lib/ionoscloud/models/datacenters.rb,
lib/ionoscloud/models/group_share.rb,
lib/ionoscloud/models/group_users.rb,
lib/ionoscloud/models/ip_consumer.rb,
lib/ionoscloud/models/ip_failover.rb,
lib/ionoscloud/models/nat_gateway.rb,
lib/ionoscloud/models/backup_units.rb,
lib/ionoscloud/models/flow_log_put.rb,
lib/ionoscloud/models/group_shares.rb,
lib/ionoscloud/models/lan_entities.rb,
lib/ionoscloud/models/loadbalancer.rb,
lib/ionoscloud/models/nat_gateways.rb,
lib/ionoscloud/models/nic_entities.rb,
lib/ionoscloud/models/target_group.rb,
lib/ionoscloud/api/backup_units_api.rb,
lib/ionoscloud/api/data_centers_api.rb,
lib/ionoscloud/api/nat_gateways_api.rb,
lib/ionoscloud/api/user_s3_keys_api.rb,
lib/ionoscloud/models/balanced_nics.rb,
lib/ionoscloud/models/error_message.rb,
lib/ionoscloud/models/firewall_rule.rb,
lib/ionoscloud/models/group_members.rb,
lib/ionoscloud/models/loadbalancers.rb,
lib/ionoscloud/models/target_groups.rb,
lib/ionoscloud/models/user_metadata.rb,
lib/ionoscloud/api/target_groups_api.rb,
lib/ionoscloud/models/firewall_rules.rb,
lib/ionoscloud/models/group_entities.rb,
lib/ionoscloud/models/label_resource.rb,
lib/ionoscloud/models/lan_properties.rb,
lib/ionoscloud/models/nic_properties.rb,
lib/ionoscloud/models/request_status.rb,
lib/ionoscloud/models/request_target.rb,
lib/ionoscloud/models/users_entities.rb,
lib/ionoscloud/api/firewall_rules_api.rb,
lib/ionoscloud/api/load_balancers_api.rb,
lib/ionoscloud/models/backup_unit_sso.rb,
lib/ionoscloud/models/kubernetes_node.rb,
lib/ionoscloud/models/label_resources.rb,
lib/ionoscloud/models/nat_gateway_put.rb,
lib/ionoscloud/models/resource_groups.rb,
lib/ionoscloud/models/resource_limits.rb,
lib/ionoscloud/models/resources_users.rb,
lib/ionoscloud/models/s3_key_metadata.rb,
lib/ionoscloud/models/server_entities.rb,
lib/ionoscloud/models/user_properties.rb,
lib/ionoscloud/api/user_management_api.rb,
lib/ionoscloud/models/attached_volumes.rb,
lib/ionoscloud/models/group_properties.rb,
lib/ionoscloud/models/image_properties.rb,
lib/ionoscloud/models/kubernetes_nodes.rb,
lib/ionoscloud/models/label_properties.rb,
lib/ionoscloud/models/nat_gateway_rule.rb,
lib/ionoscloud/models/pagination_links.rb,
lib/ionoscloud/models/request_metadata.rb,
lib/ionoscloud/models/target_group_put.rb,
lib/ionoscloud/models/nat_gateway_rules.rb,
lib/ionoscloud/models/resource_entities.rb,
lib/ionoscloud/models/s3_key_properties.rb,
lib/ionoscloud/models/server_properties.rb,
lib/ionoscloud/models/target_port_range.rb,
lib/ionoscloud/models/volume_properties.rb,
lib/ionoscloud/models/kubernetes_cluster.rb,
lib/ionoscloud/models/no_state_meta_data.rb,
lib/ionoscloud/models/remote_console_url.rb,
lib/ionoscloud/models/request_properties.rb,
lib/ionoscloud/models/resource_reference.rb,
lib/ionoscloud/api/contract_resources_api.rb,
lib/ionoscloud/api/network_interfaces_api.rb,
lib/ionoscloud/models/contract_properties.rb,
lib/ionoscloud/models/flow_log_properties.rb,
lib/ionoscloud/models/ip_block_properties.rb,
lib/ionoscloud/models/kubernetes_clusters.rb,
lib/ionoscloud/models/lan_properties_post.rb,
lib/ionoscloud/models/location_properties.rb,
lib/ionoscloud/models/resource_properties.rb,
lib/ionoscloud/models/snapshot_properties.rb,
lib/ionoscloud/models/target_group_target.rb,
lib/ionoscloud/models/template_properties.rb,
lib/ionoscloud/models/user_properties_put.rb,
lib/ionoscloud/models/data_center_entities.rb,
lib/ionoscloud/models/kubernetes_node_pool.rb,
lib/ionoscloud/models/nat_gateway_entities.rb,
lib/ionoscloud/models/nat_gateway_rule_put.rb,
lib/ionoscloud/models/user_properties_post.rb,
lib/ionoscloud/models/datacenter_properties.rb,
lib/ionoscloud/models/kubernetes_node_pools.rb,
lib/ionoscloud/models/loadbalancer_entities.rb,
lib/ionoscloud/models/nat_gateway_rule_type.rb,
lib/ionoscloud/models/network_load_balancer.rb,
lib/ionoscloud/models/private_cross_connect.rb,
lib/ionoscloud/models/s3_object_storage_sso.rb,
lib/ionoscloud/models/backup_unit_properties.rb,
lib/ionoscloud/models/connectable_datacenter.rb,
lib/ionoscloud/models/group_share_properties.rb,
lib/ionoscloud/models/nat_gateway_properties.rb,
lib/ionoscloud/models/network_load_balancers.rb,
lib/ionoscloud/models/private_cross_connects.rb,
lib/ionoscloud/api/network_load_balancers_api.rb,
lib/ionoscloud/api/private_cross_connects_api.rb,
lib/ionoscloud/models/firewallrule_properties.rb,
lib/ionoscloud/models/kubernetes_auto_scaling.rb,
lib/ionoscloud/models/loadbalancer_properties.rb,
lib/ionoscloud/models/request_status_metadata.rb,
lib/ionoscloud/models/target_group_properties.rb,
lib/ionoscloud/models/kubernetes_node_metadata.rb,
lib/ionoscloud/models/kubernetes_node_pool_lan.rb,
lib/ionoscloud/models/application_load_balancer.rb,
lib/ionoscloud/models/label_resource_properties.rb,
lib/ionoscloud/models/nat_gateway_rule_protocol.rb,
lib/ionoscloud/models/network_load_balancer_put.rb,
lib/ionoscloud/models/target_group_health_check.rb,
lib/ionoscloud/models/application_load_balancers.rb,
lib/ionoscloud/models/kubernetes_cluster_for_put.rb,
lib/ionoscloud/models/kubernetes_node_properties.rb,
lib/ionoscloud/models/nat_gateway_lan_properties.rb,
lib/ionoscloud/api/application_load_balancers_api.rb,
lib/ionoscloud/models/cpu_architecture_properties.rb,
lib/ionoscloud/models/datacenter_element_metadata.rb,
lib/ionoscloud/models/kubernetes_cluster_entities.rb,
lib/ionoscloud/models/kubernetes_cluster_for_post.rb,
lib/ionoscloud/models/nat_gateway_rule_properties.rb,
lib/ionoscloud/models/kubernetes_node_pool_for_put.rb,
lib/ionoscloud/models/application_load_balancer_put.rb,
lib/ionoscloud/models/kubernetes_cluster_properties.rb,
lib/ionoscloud/models/kubernetes_maintenance_window.rb,
lib/ionoscloud/models/kubernetes_node_pool_for_post.rb,
lib/ionoscloud/models/network_load_balancer_entities.rb,
lib/ionoscloud/models/target_group_http_health_check.rb,
lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb,
lib/ionoscloud/models/kubernetes_node_pool_properties.rb,
lib/ionoscloud/models/network_load_balancer_properties.rb,
lib/ionoscloud/models/private_cross_connect_properties.rb,
lib/ionoscloud/models/application_load_balancer_entities.rb,
lib/ionoscloud/models/application_load_balancer_http_rule.rb,
lib/ionoscloud/models/application_load_balancer_properties.rb,
lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb,
lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb,
lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb,
lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb,
lib/ionoscloud/models/application_load_balancer_forwarding_rule.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb,
lib/ionoscloud/models/application_load_balancer_forwarding_rules.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb,
lib/ionoscloud/models/application_load_balancer_forwarding_rule_put.rb,
lib/ionoscloud/models/application_load_balancer_http_rule_condition.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb,
lib/ionoscloud/models/application_load_balancer_forwarding_rule_properties.rb,
lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb

Overview

#CLOUD API

#IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the "Data Center Designer" (DCD) browser-based tool. Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.

The version of the OpenAPI document: 6.0

Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.1-SNAPSHOT

Defined Under Namespace

Classes: ApiClient, ApiError, ApplicationLoadBalancer, ApplicationLoadBalancerEntities, ApplicationLoadBalancerForwardingRule, ApplicationLoadBalancerForwardingRuleProperties, ApplicationLoadBalancerForwardingRulePut, ApplicationLoadBalancerForwardingRules, ApplicationLoadBalancerHttpRule, ApplicationLoadBalancerHttpRuleCondition, ApplicationLoadBalancerProperties, ApplicationLoadBalancerPut, ApplicationLoadBalancers, ApplicationLoadBalancersApi, AttachedVolumes, BackupUnit, BackupUnitProperties, BackupUnitSSO, BackupUnits, BackupUnitsApi, BalancedNics, Cdroms, Configuration, ConnectableDatacenter, Contract, ContractProperties, ContractResourcesApi, Contracts, CpuArchitectureProperties, DataCenterEntities, DataCentersApi, Datacenter, DatacenterElementMetadata, DatacenterProperties, Datacenters, DefaultApi, Error, ErrorMessage, FirewallRule, FirewallRules, FirewallRulesApi, FirewallruleProperties, FlowLog, FlowLogProperties, FlowLogPut, FlowLogs, FlowLogsApi, Group, GroupEntities, GroupMembers, GroupProperties, GroupShare, GroupShareProperties, GroupShares, GroupUsers, Groups, IPBlocksApi, IPFailover, Image, ImageProperties, Images, ImagesApi, Info, IpBlock, IpBlockProperties, IpBlocks, IpConsumer, KubernetesApi, KubernetesAutoScaling, KubernetesCluster, KubernetesClusterEntities, KubernetesClusterForPost, KubernetesClusterForPut, KubernetesClusterProperties, KubernetesClusterPropertiesForPost, KubernetesClusterPropertiesForPut, KubernetesClusters, KubernetesMaintenanceWindow, KubernetesNode, KubernetesNodeMetadata, KubernetesNodePool, KubernetesNodePoolForPost, KubernetesNodePoolForPut, KubernetesNodePoolLan, KubernetesNodePoolLanRoutes, KubernetesNodePoolProperties, KubernetesNodePoolPropertiesForPost, KubernetesNodePoolPropertiesForPut, KubernetesNodePools, KubernetesNodeProperties, KubernetesNodes, LANsApi, Label, LabelProperties, LabelResource, LabelResourceProperties, LabelResources, Labels, LabelsApi, Lan, LanEntities, LanNics, LanPost, LanProperties, LanPropertiesPost, Lans, LoadBalancersApi, Loadbalancer, LoadbalancerEntities, LoadbalancerProperties, Loadbalancers, Location, LocationProperties, Locations, LocationsApi, NATGatewaysApi, NatGateway, NatGatewayEntities, NatGatewayLanProperties, NatGatewayProperties, NatGatewayPut, NatGatewayRule, NatGatewayRuleProperties, NatGatewayRuleProtocol, NatGatewayRulePut, NatGatewayRuleType, NatGatewayRules, NatGateways, NetworkInterfacesApi, NetworkLoadBalancer, NetworkLoadBalancerEntities, NetworkLoadBalancerForwardingRule, NetworkLoadBalancerForwardingRuleHealthCheck, NetworkLoadBalancerForwardingRuleProperties, NetworkLoadBalancerForwardingRulePut, NetworkLoadBalancerForwardingRuleTarget, NetworkLoadBalancerForwardingRuleTargetHealthCheck, NetworkLoadBalancerForwardingRules, NetworkLoadBalancerProperties, NetworkLoadBalancerPut, NetworkLoadBalancers, NetworkLoadBalancersApi, Nic, NicEntities, NicProperties, NicPut, Nics, NoStateMetaData, PaginationLinks, Peer, PrivateCrossConnect, PrivateCrossConnectProperties, PrivateCrossConnects, PrivateCrossConnectsApi, RemoteConsoleUrl, Request, RequestMetadata, RequestProperties, RequestStatus, RequestStatusMetadata, RequestTarget, Requests, RequestsApi, Resource, ResourceEntities, ResourceGroups, ResourceLimits, ResourceProperties, ResourceReference, Resources, ResourcesUsers, S3Bucket, S3Key, S3KeyMetadata, S3KeyProperties, S3Keys, S3ObjectStorageSSO, Server, ServerEntities, ServerProperties, Servers, ServersApi, Snapshot, SnapshotProperties, Snapshots, SnapshotsApi, TargetGroup, TargetGroupHealthCheck, TargetGroupHttpHealthCheck, TargetGroupProperties, TargetGroupPut, TargetGroupTarget, TargetGroups, TargetGroupsApi, TargetPortRange, Template, TemplateProperties, Templates, TemplatesApi, Token, Type, User, UserManagementApi, UserMetadata, UserPost, UserProperties, UserPropertiesPost, UserPropertiesPut, UserPut, UserS3KeysApi, Users, UsersEntities, Volume, VolumeProperties, Volumes, VolumesApi

Constant Summary collapse

VERSION = 
'6.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Ionoscloud.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



244
245
246
247
248
249
250
 
# File 'lib/ionoscloud.rb', line 244

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end