ionoscloud 5.1.1 → 6.0.0.beta.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -19
- data/docs/CHANGELOG.md +1 -0
- data/docs/README.md +4 -4
- data/docs/api/BackupUnitsApi.md +594 -0
- data/docs/api/ContractResourcesApi.md +89 -0
- data/docs/api/DataCentersApi.md +516 -0
- data/docs/api/DefaultApi.md +8 -19
- data/docs/api/FirewallRulesApi.md +552 -0
- data/docs/api/FlowLogsApi.md +540 -0
- data/docs/api/IPBlocksApi.md +50 -51
- data/docs/api/ImagesApi.md +428 -0
- data/docs/api/KubernetesApi.md +131 -211
- data/docs/api/LabelsApi.md +2338 -0
- data/docs/api/LansApi.md +794 -0
- data/docs/api/LoadBalancersApi.md +877 -0
- data/docs/api/LocationsApi.md +259 -0
- data/docs/api/NATGatewaysApi.md +1574 -0
- data/docs/api/NetworkInterfacesApi.md +540 -0
- data/docs/api/NetworkLoadBalancersApi.md +1586 -0
- data/docs/api/PrivateCrossConnectsApi.md +426 -0
- data/docs/api/{RequestApi.md → RequestsApi.md} +36 -36
- data/docs/api/ServersApi.md +1908 -0
- data/docs/api/SnapshotsApi.md +428 -0
- data/docs/api/TemplatesApi.md +165 -0
- data/docs/api/UserManagementApi.md +173 -687
- data/docs/api/UserS3KeysApi.md +516 -0
- data/docs/api/VolumesApi.md +709 -0
- data/docs/models/AttachedVolumes.md +1 -1
- data/docs/models/Cdroms.md +1 -1
- data/docs/models/Contracts.md +24 -0
- data/docs/models/CpuArchitectureProperties.md +24 -0
- data/docs/models/DataCenterEntities.md +5 -1
- data/docs/models/DatacenterProperties.md +3 -1
- data/docs/models/FirewallruleProperties.md +3 -1
- data/docs/models/FlowLog.md +26 -0
- data/docs/models/FlowLogProperties.md +24 -0
- data/docs/models/FlowLogPut.md +24 -0
- data/docs/models/FlowLogs.md +30 -0
- data/docs/models/Group.md +1 -1
- data/docs/models/GroupMembers.md +1 -1
- data/docs/models/GroupProperties.md +7 -1
- data/docs/models/GroupShare.md +1 -1
- data/docs/models/GroupShares.md +1 -1
- data/docs/models/GroupUsers.md +1 -1
- data/docs/models/Groups.md +1 -1
- data/docs/models/KubernetesAutoScaling.md +2 -2
- data/docs/models/KubernetesClusterProperties.md +1 -1
- data/docs/models/KubernetesClusterPropertiesForPost.md +1 -1
- data/docs/models/KubernetesClusterPropertiesForPut.md +1 -1
- data/docs/models/KubernetesClusters.md +1 -1
- data/docs/models/KubernetesMaintenanceWindow.md +2 -2
- data/docs/models/KubernetesNodePoolLan.md +5 -1
- data/docs/models/KubernetesNodePoolLanRoutes.md +20 -0
- data/docs/models/KubernetesNodePools.md +1 -1
- data/docs/models/Lans.md +1 -1
- data/docs/models/LocationProperties.md +3 -1
- data/docs/models/NatGateway.md +28 -0
- data/docs/models/NatGatewayEntities.md +20 -0
- data/docs/models/NatGatewayLanProperties.md +20 -0
- data/docs/models/NatGatewayProperties.md +22 -0
- data/docs/models/NatGatewayPut.md +24 -0
- data/docs/models/NatGatewayRule.md +26 -0
- data/docs/models/NatGatewayRuleProperties.md +30 -0
- data/docs/models/NatGatewayRuleProtocol.md +15 -0
- data/docs/models/NatGatewayRulePut.md +24 -0
- data/docs/models/NatGatewayRuleType.md +15 -0
- data/docs/models/NatGatewayRules.md +24 -0
- data/docs/models/NatGateways.md +30 -0
- data/docs/models/NetworkLoadBalancer.md +28 -0
- data/docs/models/NetworkLoadBalancerEntities.md +20 -0
- data/docs/models/NetworkLoadBalancerForwardingRule.md +26 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
- data/docs/models/NetworkLoadBalancerForwardingRulePut.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
- data/docs/models/NetworkLoadBalancerForwardingRules.md +30 -0
- data/docs/models/NetworkLoadBalancerProperties.md +26 -0
- data/docs/models/NetworkLoadBalancerPut.md +24 -0
- data/docs/models/NetworkLoadBalancers.md +30 -0
- data/docs/models/NicEntities.md +2 -0
- data/docs/models/NicProperties.md +6 -2
- data/docs/models/NicPut.md +24 -0
- data/docs/models/Nics.md +1 -1
- data/docs/models/PrivateCrossConnectProperties.md +1 -1
- data/docs/models/RemoteConsoleUrl.md +18 -0
- data/docs/models/Resource.md +1 -1
- data/docs/models/ResourceGroups.md +1 -1
- data/docs/models/ResourceLimits.md +11 -1
- data/docs/models/ResourceProperties.md +1 -1
- data/docs/models/Resources.md +1 -1
- data/docs/models/ResourcesUsers.md +1 -1
- data/docs/models/S3Bucket.md +1 -1
- data/docs/models/S3Key.md +1 -1
- data/docs/models/S3Keys.md +1 -1
- data/docs/models/ServerProperties.md +6 -2
- data/docs/models/TargetPortRange.md +20 -0
- data/docs/models/Template.md +26 -0
- data/docs/models/TemplateProperties.md +24 -0
- data/docs/models/Templates.md +24 -0
- data/docs/models/Token.md +18 -0
- data/docs/models/VolumeProperties.md +5 -3
- data/docs/summary.md +386 -159
- data/ionoscloud.gemspec +3 -3
- data/lib/ionoscloud/api/_api.rb +9 -9
- data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +101 -101
- data/lib/ionoscloud/api/contract_resources_api.rb +96 -0
- data/lib/ionoscloud/api/data_centers_api.rb +532 -0
- data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
- data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
- data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +71 -71
- data/lib/ionoscloud/api/ip_blocks_api.rb +55 -55
- data/lib/ionoscloud/api/kubernetes_api.rb +131 -194
- data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +416 -470
- data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +178 -178
- data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +198 -216
- data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +49 -49
- data/lib/ionoscloud/api/nat_gateways_api.rb +1672 -0
- data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
- data/lib/ionoscloud/api/network_load_balancers_api.rb +1690 -0
- data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +76 -76
- data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +45 -45
- data/lib/ionoscloud/api/servers_api.rb +2023 -0
- data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +77 -77
- data/lib/ionoscloud/api/templates_api.rb +164 -0
- data/lib/ionoscloud/api/user_management_api.rb +172 -667
- data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
- data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +145 -145
- data/lib/ionoscloud/api_client.rb +5 -5
- data/lib/ionoscloud/api_error.rb +2 -2
- data/lib/ionoscloud/configuration.rb +4 -4
- data/lib/ionoscloud/models/attached_volumes.rb +2 -2
- data/lib/ionoscloud/models/backup_unit.rb +2 -2
- data/lib/ionoscloud/models/backup_unit_properties.rb +2 -2
- data/lib/ionoscloud/models/backup_unit_sso.rb +2 -2
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/balanced_nics.rb +2 -2
- data/lib/ionoscloud/models/cdroms.rb +2 -2
- data/lib/ionoscloud/models/connectable_datacenter.rb +2 -2
- data/lib/ionoscloud/models/contract.rb +2 -2
- data/lib/ionoscloud/models/contract_properties.rb +2 -2
- data/lib/ionoscloud/models/contracts.rb +251 -0
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +249 -0
- data/lib/ionoscloud/models/data_center_entities.rb +24 -6
- data/lib/ionoscloud/models/datacenter.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +4 -4
- data/lib/ionoscloud/models/datacenter_properties.rb +18 -6
- data/lib/ionoscloud/models/datacenters.rb +2 -2
- data/lib/ionoscloud/models/error.rb +2 -2
- data/lib/ionoscloud/models/error_message.rb +2 -2
- data/lib/ionoscloud/models/firewall_rule.rb +2 -2
- data/lib/ionoscloud/models/firewall_rules.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +28 -6
- data/lib/ionoscloud/models/flow_log.rb +262 -0
- data/lib/ionoscloud/models/flow_log_properties.rb +315 -0
- data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +9 -43
- data/lib/ionoscloud/models/flow_logs.rb +280 -0
- data/lib/ionoscloud/models/group.rb +2 -2
- data/lib/ionoscloud/models/group_entities.rb +2 -2
- data/lib/ionoscloud/models/group_members.rb +2 -2
- data/lib/ionoscloud/models/group_properties.rb +36 -6
- data/lib/ionoscloud/models/group_share.rb +2 -2
- data/lib/ionoscloud/models/group_share_properties.rb +2 -2
- data/lib/ionoscloud/models/group_shares.rb +2 -2
- data/lib/ionoscloud/models/group_users.rb +2 -2
- data/lib/ionoscloud/models/groups.rb +2 -2
- data/lib/ionoscloud/models/image.rb +2 -2
- data/lib/ionoscloud/models/image_properties.rb +2 -2
- data/lib/ionoscloud/models/images.rb +2 -2
- data/lib/ionoscloud/models/info.rb +2 -2
- data/lib/ionoscloud/models/ip_block.rb +2 -2
- data/lib/ionoscloud/models/ip_block_properties.rb +2 -2
- data/lib/ionoscloud/models/ip_blocks.rb +2 -2
- data/lib/ionoscloud/models/ip_consumer.rb +2 -2
- data/lib/ionoscloud/models/ip_failover.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +12 -2
- data/lib/ionoscloud/models/kubernetes_cluster.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_clusters.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +12 -2
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +4 -4
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -6
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +229 -0
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +3 -3
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label.rb +2 -2
- data/lib/ionoscloud/models/label_properties.rb +2 -2
- data/lib/ionoscloud/models/label_resource.rb +2 -2
- data/lib/ionoscloud/models/label_resource_properties.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/lan.rb +2 -2
- data/lib/ionoscloud/models/lan_entities.rb +2 -2
- data/lib/ionoscloud/models/lan_nics.rb +2 -2
- data/lib/ionoscloud/models/lan_post.rb +2 -2
- data/lib/ionoscloud/models/lan_properties.rb +2 -2
- data/lib/ionoscloud/models/lan_properties_post.rb +2 -2
- data/lib/ionoscloud/models/lans.rb +3 -3
- data/lib/ionoscloud/models/loadbalancer.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_entities.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +2 -2
- data/lib/ionoscloud/models/loadbalancers.rb +2 -2
- data/lib/ionoscloud/models/location.rb +2 -2
- data/lib/ionoscloud/models/location_properties.rb +18 -6
- data/lib/ionoscloud/models/locations.rb +2 -2
- data/lib/ionoscloud/models/nat_gateway.rb +271 -0
- data/lib/ionoscloud/models/nat_gateway_entities.rb +227 -0
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +236 -0
- data/lib/ionoscloud/models/nat_gateway_properties.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_put.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_rule.rb +262 -0
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +293 -0
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +253 -0
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
- data/lib/ionoscloud/models/nat_gateway_rules.rb +251 -0
- data/lib/ionoscloud/models/nat_gateways.rb +280 -0
- data/lib/ionoscloud/models/network_load_balancer.rb +271 -0
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +227 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +262 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +249 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +356 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +253 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +263 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +239 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +280 -0
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer_put.rb +253 -0
- data/lib/ionoscloud/models/network_load_balancers.rb +280 -0
- data/lib/ionoscloud/models/nic.rb +2 -2
- data/lib/ionoscloud/models/nic_entities.rb +12 -3
- data/lib/ionoscloud/models/nic_properties.rb +64 -10
- data/lib/ionoscloud/models/nic_put.rb +253 -0
- data/lib/ionoscloud/models/nics.rb +2 -2
- data/lib/ionoscloud/models/no_state_meta_data.rb +2 -2
- data/lib/ionoscloud/models/pagination_links.rb +2 -2
- data/lib/ionoscloud/models/peer.rb +2 -2
- data/lib/ionoscloud/models/private_cross_connect.rb +2 -2
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +3 -3
- data/lib/ionoscloud/models/private_cross_connects.rb +2 -2
- data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -13
- data/lib/ionoscloud/models/request.rb +2 -2
- data/lib/ionoscloud/models/request_metadata.rb +2 -2
- data/lib/ionoscloud/models/request_properties.rb +2 -2
- data/lib/ionoscloud/models/request_status.rb +2 -2
- data/lib/ionoscloud/models/request_status_metadata.rb +2 -2
- data/lib/ionoscloud/models/request_target.rb +2 -2
- data/lib/ionoscloud/models/requests.rb +2 -2
- data/lib/ionoscloud/models/resource.rb +2 -2
- data/lib/ionoscloud/models/resource_entities.rb +2 -2
- data/lib/ionoscloud/models/resource_groups.rb +2 -2
- data/lib/ionoscloud/models/resource_limits.rb +81 -6
- data/lib/ionoscloud/models/resource_properties.rb +3 -3
- data/lib/ionoscloud/models/resource_reference.rb +2 -2
- data/lib/ionoscloud/models/resources.rb +2 -2
- data/lib/ionoscloud/models/resources_users.rb +2 -2
- data/lib/ionoscloud/models/s3_bucket.rb +3 -3
- data/lib/ionoscloud/models/s3_key.rb +2 -2
- data/lib/ionoscloud/models/s3_key_metadata.rb +2 -2
- data/lib/ionoscloud/models/s3_key_properties.rb +2 -2
- data/lib/ionoscloud/models/s3_keys.rb +2 -2
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +2 -2
- data/lib/ionoscloud/models/server.rb +2 -2
- data/lib/ionoscloud/models/server_entities.rb +2 -2
- data/lib/ionoscloud/models/server_properties.rb +27 -7
- data/lib/ionoscloud/models/servers.rb +2 -2
- data/lib/ionoscloud/models/snapshot.rb +2 -2
- data/lib/ionoscloud/models/snapshot_properties.rb +2 -2
- data/lib/ionoscloud/models/snapshots.rb +2 -2
- data/lib/ionoscloud/models/target_port_range.rb +229 -0
- data/lib/ionoscloud/models/template.rb +262 -0
- data/lib/ionoscloud/models/template_properties.rb +269 -0
- data/lib/ionoscloud/models/templates.rb +251 -0
- data/lib/ionoscloud/models/token.rb +219 -0
- data/lib/ionoscloud/models/type.rb +10 -2
- data/lib/ionoscloud/models/user.rb +2 -2
- data/lib/ionoscloud/models/user_metadata.rb +2 -2
- data/lib/ionoscloud/models/user_post.rb +2 -2
- data/lib/ionoscloud/models/user_properties.rb +2 -2
- data/lib/ionoscloud/models/user_properties_post.rb +2 -2
- data/lib/ionoscloud/models/user_properties_put.rb +2 -2
- data/lib/ionoscloud/models/user_put.rb +2 -2
- data/lib/ionoscloud/models/users.rb +2 -2
- data/lib/ionoscloud/models/users_entities.rb +2 -2
- data/lib/ionoscloud/models/volume.rb +2 -2
- data/lib/ionoscloud/models/volume_properties.rb +16 -6
- data/lib/ionoscloud/models/volumes.rb +2 -2
- data/lib/ionoscloud/version.rb +3 -3
- data/lib/ionoscloud.rb +60 -18
- data/spec/api/_api_spec.rb +5 -5
- data/spec/api/backup_units_api_spec.rb +140 -0
- data/spec/api/contract_resources_api_spec.rb +49 -0
- data/spec/api/data_centers_api_spec.rb +128 -0
- data/spec/api/firewall_rules_api_spec.rb +146 -0
- data/spec/api/flow_logs_api_spec.rb +140 -0
- data/spec/api/images_api_spec.rb +111 -0
- data/spec/api/ip_blocks_api_spec.rb +27 -27
- data/spec/api/kubernetes_api_spec.rb +55 -67
- data/spec/api/labels_api_spec.rb +474 -0
- data/spec/api/lans_api_spec.rb +186 -0
- data/spec/api/load_balancers_api_spec.rb +201 -0
- data/spec/api/locations_api_spec.rb +80 -0
- data/spec/api/nat_gateways_api_spec.rb +334 -0
- data/spec/api/network_interfaces_api_spec.rb +140 -0
- data/spec/api/network_load_balancers_api_spec.rb +340 -0
- data/spec/api/private_cross_connects_api_spec.rb +110 -0
- data/spec/api/{request_api_spec.rb → requests_api_spec.rb} +19 -19
- data/spec/api/servers_api_spec.rb +401 -0
- data/spec/api/snapshots_api_spec.rb +111 -0
- data/spec/api/templates_api_spec.rb +60 -0
- data/spec/api/user_management_api_spec.rb +81 -174
- data/spec/api/user_s3_keys_api_spec.rb +128 -0
- data/spec/api/volumes_api_spec.rb +171 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/attached_volumes_spec.rb +2 -2
- data/spec/models/backup_unit_properties_spec.rb +2 -2
- data/spec/models/backup_unit_spec.rb +2 -2
- data/spec/models/backup_unit_sso_spec.rb +2 -2
- data/spec/models/backup_units_spec.rb +2 -2
- data/spec/models/balanced_nics_spec.rb +2 -2
- data/spec/models/cdroms_spec.rb +2 -2
- data/spec/models/connectable_datacenter_spec.rb +2 -2
- data/spec/models/contract_properties_spec.rb +2 -2
- data/spec/models/contract_spec.rb +2 -2
- data/spec/models/contracts_spec.rb +52 -0
- data/spec/models/cpu_architecture_properties_spec.rb +52 -0
- data/spec/models/data_center_entities_spec.rb +14 -2
- data/spec/models/datacenter_element_metadata_spec.rb +3 -3
- data/spec/models/datacenter_properties_spec.rb +8 -2
- data/spec/models/datacenter_spec.rb +2 -2
- data/spec/models/datacenters_spec.rb +2 -2
- data/spec/models/error_message_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/firewall_rule_spec.rb +2 -2
- data/spec/models/firewall_rules_spec.rb +2 -2
- data/spec/models/firewallrule_properties_spec.rb +12 -2
- data/spec/models/flow_log_properties_spec.rb +60 -0
- data/spec/models/flow_log_put_spec.rb +52 -0
- data/spec/models/flow_log_spec.rb +58 -0
- data/spec/models/flow_logs_spec.rb +70 -0
- data/spec/models/group_entities_spec.rb +2 -2
- data/spec/models/group_members_spec.rb +2 -2
- data/spec/models/group_properties_spec.rb +20 -2
- data/spec/models/group_share_properties_spec.rb +2 -2
- data/spec/models/group_share_spec.rb +2 -2
- data/spec/models/group_shares_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/group_users_spec.rb +2 -2
- data/spec/models/groups_spec.rb +2 -2
- data/spec/models/image_properties_spec.rb +2 -2
- data/spec/models/image_spec.rb +2 -2
- data/spec/models/images_spec.rb +2 -2
- data/spec/models/info_spec.rb +2 -2
- data/spec/models/ip_block_properties_spec.rb +2 -2
- data/spec/models/ip_block_spec.rb +2 -2
- data/spec/models/ip_blocks_spec.rb +2 -2
- data/spec/models/ip_consumer_spec.rb +2 -2
- data/spec/models/ip_failover_spec.rb +2 -2
- data/spec/models/kubernetes_auto_scaling_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_entities_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_properties_spec.rb +2 -2
- data/spec/models/kubernetes_cluster_spec.rb +2 -2
- data/spec/models/kubernetes_clusters_spec.rb +2 -2
- data/spec/models/kubernetes_maintenance_window_spec.rb +2 -2
- data/spec/models/kubernetes_node_metadata_spec.rb +3 -3
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
- data/spec/models/kubernetes_node_pool_lan_spec.rb +14 -2
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_properties_spec.rb +2 -2
- data/spec/models/kubernetes_node_pool_spec.rb +2 -2
- data/spec/models/kubernetes_node_pools_spec.rb +2 -2
- data/spec/models/kubernetes_node_properties_spec.rb +2 -2
- data/spec/models/kubernetes_node_spec.rb +2 -2
- data/spec/models/kubernetes_nodes_spec.rb +2 -2
- data/spec/models/label_properties_spec.rb +2 -2
- data/spec/models/label_resource_properties_spec.rb +2 -2
- data/spec/models/label_resource_spec.rb +2 -2
- data/spec/models/label_resources_spec.rb +2 -2
- data/spec/models/label_spec.rb +2 -2
- data/spec/models/labels_spec.rb +2 -2
- data/spec/models/lan_entities_spec.rb +2 -2
- data/spec/models/lan_nics_spec.rb +2 -2
- data/spec/models/lan_post_spec.rb +2 -2
- data/spec/models/lan_properties_post_spec.rb +2 -2
- data/spec/models/lan_properties_spec.rb +2 -2
- data/spec/models/lan_spec.rb +2 -2
- data/spec/models/lans_spec.rb +2 -2
- data/spec/models/loadbalancer_entities_spec.rb +2 -2
- data/spec/models/loadbalancer_properties_spec.rb +2 -2
- data/spec/models/loadbalancer_spec.rb +2 -2
- data/spec/models/loadbalancers_spec.rb +2 -2
- data/spec/models/location_properties_spec.rb +8 -2
- data/spec/models/location_spec.rb +2 -2
- data/spec/models/locations_spec.rb +2 -2
- data/spec/models/nat_gateway_entities_spec.rb +40 -0
- data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
- data/spec/models/nat_gateway_properties_spec.rb +46 -0
- data/spec/models/nat_gateway_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
- data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
- data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_spec.rb +58 -0
- data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
- data/spec/models/nat_gateway_rules_spec.rb +52 -0
- data/spec/models/nat_gateway_spec.rb +64 -0
- data/spec/models/nat_gateways_spec.rb +70 -0
- data/spec/models/network_load_balancer_entities_spec.rb +40 -0
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
- data/spec/models/network_load_balancer_properties_spec.rb +58 -0
- data/spec/models/network_load_balancer_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_spec.rb +64 -0
- data/spec/models/network_load_balancers_spec.rb +70 -0
- data/spec/models/nic_entities_spec.rb +8 -2
- data/spec/models/nic_properties_spec.rb +19 -3
- data/spec/models/nic_put_spec.rb +52 -0
- data/spec/models/nic_spec.rb +2 -2
- data/spec/models/nics_spec.rb +2 -2
- data/spec/models/no_state_meta_data_spec.rb +2 -2
- data/spec/models/pagination_links_spec.rb +2 -2
- data/spec/models/peer_spec.rb +2 -2
- data/spec/models/private_cross_connect_properties_spec.rb +2 -2
- data/spec/models/private_cross_connect_spec.rb +2 -2
- data/spec/models/private_cross_connects_spec.rb +2 -2
- data/spec/models/remote_console_url_spec.rb +34 -0
- data/spec/models/request_metadata_spec.rb +2 -2
- data/spec/models/request_properties_spec.rb +2 -2
- data/spec/models/request_spec.rb +2 -2
- data/spec/models/request_status_metadata_spec.rb +2 -2
- data/spec/models/request_status_spec.rb +2 -2
- data/spec/models/request_target_spec.rb +2 -2
- data/spec/models/requests_spec.rb +2 -2
- data/spec/models/resource_entities_spec.rb +2 -2
- data/spec/models/resource_groups_spec.rb +2 -2
- data/spec/models/resource_limits_spec.rb +32 -2
- data/spec/models/resource_properties_spec.rb +2 -2
- data/spec/models/resource_reference_spec.rb +2 -2
- data/spec/models/resource_spec.rb +2 -2
- data/spec/models/resources_spec.rb +2 -2
- data/spec/models/resources_users_spec.rb +2 -2
- data/spec/models/s3_bucket_spec.rb +2 -2
- data/spec/models/s3_key_metadata_spec.rb +2 -2
- data/spec/models/s3_key_properties_spec.rb +2 -2
- data/spec/models/s3_key_spec.rb +2 -2
- data/spec/models/s3_keys_spec.rb +2 -2
- data/spec/models/s3_object_storage_sso_spec.rb +2 -2
- data/spec/models/server_entities_spec.rb +2 -2
- data/spec/models/server_properties_spec.rb +14 -2
- data/spec/models/server_spec.rb +2 -2
- data/spec/models/servers_spec.rb +2 -2
- data/spec/models/snapshot_properties_spec.rb +2 -2
- data/spec/models/snapshot_spec.rb +2 -2
- data/spec/models/snapshots_spec.rb +2 -2
- data/spec/models/target_port_range_spec.rb +40 -0
- data/spec/models/template_properties_spec.rb +52 -0
- data/spec/models/template_spec.rb +58 -0
- data/spec/models/templates_spec.rb +52 -0
- data/spec/models/token_spec.rb +34 -0
- data/spec/models/type_spec.rb +2 -2
- data/spec/models/user_metadata_spec.rb +2 -2
- data/spec/models/user_post_spec.rb +2 -2
- data/spec/models/user_properties_post_spec.rb +2 -2
- data/spec/models/user_properties_put_spec.rb +2 -2
- data/spec/models/user_properties_spec.rb +2 -2
- data/spec/models/user_put_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/users_entities_spec.rb +2 -2
- data/spec/models/users_spec.rb +2 -2
- data/spec/models/volume_properties_spec.rb +8 -2
- data/spec/models/volume_spec.rb +2 -2
- data/spec/models/volumes_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +246 -80
- data/Gemfile.lock +0 -68
- data/docs/api/BackupUnitApi.md +0 -595
- data/docs/api/ContractApi.md +0 -89
- data/docs/api/DataCenterApi.md +0 -517
- data/docs/api/ImageApi.md +0 -429
- data/docs/api/LabelApi.md +0 -2355
- data/docs/api/LanApi.md +0 -795
- data/docs/api/LoadBalancerApi.md +0 -883
- data/docs/api/LocationApi.md +0 -259
- data/docs/api/NicApi.md +0 -1087
- data/docs/api/PrivateCrossConnectApi.md +0 -427
- data/docs/api/ServerApi.md +0 -1573
- data/docs/api/SnapshotApi.md +0 -429
- data/docs/api/VolumeApi.md +0 -711
- data/docs/models/KubernetesConfig.md +0 -24
- data/docs/models/KubernetesConfigProperties.md +0 -18
- data/lib/ionoscloud/api/contract_api.rb +0 -96
- data/lib/ionoscloud/api/data_center_api.rb +0 -532
- data/lib/ionoscloud/api/nic_api.rb +0 -1222
- data/lib/ionoscloud/api/server_api.rb +0 -1679
- data/lib/test_driver.rb +0 -104
- data/spec/api/backup_unit_api_spec.rb +0 -140
- data/spec/api/contract_api_spec.rb +0 -49
- data/spec/api/data_center_api_spec.rb +0 -128
- data/spec/api/image_api_spec.rb +0 -111
- data/spec/api/label_api_spec.rb +0 -480
- data/spec/api/lan_api_spec.rb +0 -186
- data/spec/api/load_balancer_api_spec.rb +0 -203
- data/spec/api/location_api_spec.rb +0 -80
- data/spec/api/nic_api_spec.rb +0 -251
- data/spec/api/private_cross_connect_api_spec.rb +0 -110
- data/spec/api/server_api_spec.rb +0 -337
- data/spec/api/snapshot_api_spec.rb +0 -111
- data/spec/api/volume_api_spec.rb +0 -171
- data/spec/models/kubernetes_config_properties_spec.rb +0 -34
- data/spec/models/kubernetes_config_spec.rb +0 -56
data/docs/api/LansApi.md
ADDED
@@ -0,0 +1,794 @@
|
|
1
|
+
# LansApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_lans_delete**](LansApi.md#datacenters_lans_delete) | **DELETE** /datacenters/{datacenterId}/lans/{lanId} | Delete a Lan. |
|
8
|
+
| [**datacenters_lans_find_by_id**](LansApi.md#datacenters_lans_find_by_id) | **GET** /datacenters/{datacenterId}/lans/{lanId} | Retrieve a Lan |
|
9
|
+
| [**datacenters_lans_get**](LansApi.md#datacenters_lans_get) | **GET** /datacenters/{datacenterId}/lans | List Lans |
|
10
|
+
| [**datacenters_lans_nics_find_by_id**](LansApi.md#datacenters_lans_nics_find_by_id) | **GET** /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId} | Retrieve a nic attached to lan |
|
11
|
+
| [**datacenters_lans_nics_get**](LansApi.md#datacenters_lans_nics_get) | **GET** /datacenters/{datacenterId}/lans/{lanId}/nics | List Lan Members |
|
12
|
+
| [**datacenters_lans_nics_post**](LansApi.md#datacenters_lans_nics_post) | **POST** /datacenters/{datacenterId}/lans/{lanId}/nics | Attach a nic |
|
13
|
+
| [**datacenters_lans_patch**](LansApi.md#datacenters_lans_patch) | **PATCH** /datacenters/{datacenterId}/lans/{lanId} | Partially modify a Lan |
|
14
|
+
| [**datacenters_lans_post**](LansApi.md#datacenters_lans_post) | **POST** /datacenters/{datacenterId}/lans | Create a Lan |
|
15
|
+
| [**datacenters_lans_put**](LansApi.md#datacenters_lans_put) | **PUT** /datacenters/{datacenterId}/lans/{lanId} | Modify a Lan |
|
16
|
+
|
17
|
+
|
18
|
+
## datacenters_lans_delete
|
19
|
+
|
20
|
+
> datacenters_lans_delete(datacenter_id, lan_id, opts)
|
21
|
+
|
22
|
+
Delete a Lan.
|
23
|
+
|
24
|
+
Removes the specific LAN.
|
25
|
+
|
26
|
+
### Examples
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'time'
|
30
|
+
require 'ionoscloud'
|
31
|
+
# setup authorization
|
32
|
+
Ionoscloud.configure do |config|
|
33
|
+
# Configure HTTP basic authorization: Basic Authentication
|
34
|
+
config.username = 'YOUR USERNAME'
|
35
|
+
config.password = 'YOUR PASSWORD'
|
36
|
+
|
37
|
+
# Configure API key authorization: Token Authentication
|
38
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
39
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
40
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = Ionoscloud::LansApi.new
|
44
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
45
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
46
|
+
opts = {
|
47
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
48
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
49
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
50
|
+
}
|
51
|
+
|
52
|
+
begin
|
53
|
+
# Delete a Lan.
|
54
|
+
api_instance.datacenters_lans_delete(datacenter_id, lan_id, opts)
|
55
|
+
rescue Ionoscloud::ApiError => e
|
56
|
+
puts "Error when calling LansApi->datacenters_lans_delete: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
#### Using the datacenters_lans_delete_with_http_info variant
|
61
|
+
|
62
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
63
|
+
|
64
|
+
> <Array(nil, Integer, Hash)> datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts)
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
begin
|
68
|
+
# Delete a Lan.
|
69
|
+
data, status_code, headers = api_instance.datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts)
|
70
|
+
p status_code # => 2xx
|
71
|
+
p headers # => { ... }
|
72
|
+
p data # => nil
|
73
|
+
rescue Ionoscloud::ApiError => e
|
74
|
+
puts "Error when calling LansApi->datacenters_lans_delete_with_http_info: #{e}"
|
75
|
+
end
|
76
|
+
```
|
77
|
+
|
78
|
+
### Parameters
|
79
|
+
|
80
|
+
| Name | Type | Description | Notes |
|
81
|
+
| ---- | ---- | ----------- | ----- |
|
82
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
83
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
84
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
85
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
86
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
87
|
+
|
88
|
+
### Return type
|
89
|
+
|
90
|
+
nil (empty response body)
|
91
|
+
|
92
|
+
### Authorization
|
93
|
+
|
94
|
+
Basic Authentication, Token Authentication
|
95
|
+
|
96
|
+
### HTTP request headers
|
97
|
+
|
98
|
+
- **Content-Type**: Not defined
|
99
|
+
- **Accept**: application/json
|
100
|
+
|
101
|
+
|
102
|
+
## datacenters_lans_find_by_id
|
103
|
+
|
104
|
+
> <Lan> datacenters_lans_find_by_id(datacenter_id, lan_id, opts)
|
105
|
+
|
106
|
+
Retrieve a Lan
|
107
|
+
|
108
|
+
Retrieves the attributes of a given LAN.
|
109
|
+
|
110
|
+
### Examples
|
111
|
+
|
112
|
+
```ruby
|
113
|
+
require 'time'
|
114
|
+
require 'ionoscloud'
|
115
|
+
# setup authorization
|
116
|
+
Ionoscloud.configure do |config|
|
117
|
+
# Configure HTTP basic authorization: Basic Authentication
|
118
|
+
config.username = 'YOUR USERNAME'
|
119
|
+
config.password = 'YOUR PASSWORD'
|
120
|
+
|
121
|
+
# Configure API key authorization: Token Authentication
|
122
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
125
|
+
end
|
126
|
+
|
127
|
+
api_instance = Ionoscloud::LansApi.new
|
128
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
129
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
130
|
+
opts = {
|
131
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
132
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
133
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
134
|
+
}
|
135
|
+
|
136
|
+
begin
|
137
|
+
# Retrieve a Lan
|
138
|
+
result = api_instance.datacenters_lans_find_by_id(datacenter_id, lan_id, opts)
|
139
|
+
p result
|
140
|
+
rescue Ionoscloud::ApiError => e
|
141
|
+
puts "Error when calling LansApi->datacenters_lans_find_by_id: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
#### Using the datacenters_lans_find_by_id_with_http_info variant
|
146
|
+
|
147
|
+
This returns an Array which contains the response data, status code and headers.
|
148
|
+
|
149
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts)
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
begin
|
153
|
+
# Retrieve a Lan
|
154
|
+
data, status_code, headers = api_instance.datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts)
|
155
|
+
p status_code # => 2xx
|
156
|
+
p headers # => { ... }
|
157
|
+
p data # => <Lan>
|
158
|
+
rescue Ionoscloud::ApiError => e
|
159
|
+
puts "Error when calling LansApi->datacenters_lans_find_by_id_with_http_info: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
| Name | Type | Description | Notes |
|
166
|
+
| ---- | ---- | ----------- | ----- |
|
167
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
168
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
169
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
170
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
171
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
172
|
+
|
173
|
+
### Return type
|
174
|
+
|
175
|
+
[**Lan**](Lan.md)
|
176
|
+
|
177
|
+
### Authorization
|
178
|
+
|
179
|
+
Basic Authentication, Token Authentication
|
180
|
+
|
181
|
+
### HTTP request headers
|
182
|
+
|
183
|
+
- **Content-Type**: Not defined
|
184
|
+
- **Accept**: application/json
|
185
|
+
|
186
|
+
|
187
|
+
## datacenters_lans_get
|
188
|
+
|
189
|
+
> <Lans> datacenters_lans_get(datacenter_id, opts)
|
190
|
+
|
191
|
+
List Lans
|
192
|
+
|
193
|
+
Retrieve a list of LANs within the datacenter.
|
194
|
+
|
195
|
+
### Examples
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
require 'time'
|
199
|
+
require 'ionoscloud'
|
200
|
+
# setup authorization
|
201
|
+
Ionoscloud.configure do |config|
|
202
|
+
# Configure HTTP basic authorization: Basic Authentication
|
203
|
+
config.username = 'YOUR USERNAME'
|
204
|
+
config.password = 'YOUR PASSWORD'
|
205
|
+
|
206
|
+
# Configure API key authorization: Token Authentication
|
207
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
208
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
209
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
210
|
+
end
|
211
|
+
|
212
|
+
api_instance = Ionoscloud::LansApi.new
|
213
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
214
|
+
opts = {
|
215
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
216
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
217
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
218
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
219
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
220
|
+
}
|
221
|
+
|
222
|
+
begin
|
223
|
+
# List Lans
|
224
|
+
result = api_instance.datacenters_lans_get(datacenter_id, opts)
|
225
|
+
p result
|
226
|
+
rescue Ionoscloud::ApiError => e
|
227
|
+
puts "Error when calling LansApi->datacenters_lans_get: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
#### Using the datacenters_lans_get_with_http_info variant
|
232
|
+
|
233
|
+
This returns an Array which contains the response data, status code and headers.
|
234
|
+
|
235
|
+
> <Array(<Lans>, Integer, Hash)> datacenters_lans_get_with_http_info(datacenter_id, opts)
|
236
|
+
|
237
|
+
```ruby
|
238
|
+
begin
|
239
|
+
# List Lans
|
240
|
+
data, status_code, headers = api_instance.datacenters_lans_get_with_http_info(datacenter_id, opts)
|
241
|
+
p status_code # => 2xx
|
242
|
+
p headers # => { ... }
|
243
|
+
p data # => <Lans>
|
244
|
+
rescue Ionoscloud::ApiError => e
|
245
|
+
puts "Error when calling LansApi->datacenters_lans_get_with_http_info: #{e}"
|
246
|
+
end
|
247
|
+
```
|
248
|
+
|
249
|
+
### Parameters
|
250
|
+
|
251
|
+
| Name | Type | Description | Notes |
|
252
|
+
| ---- | ---- | ----------- | ----- |
|
253
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
254
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
255
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
256
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
257
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
258
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
259
|
+
|
260
|
+
### Return type
|
261
|
+
|
262
|
+
[**Lans**](Lans.md)
|
263
|
+
|
264
|
+
### Authorization
|
265
|
+
|
266
|
+
Basic Authentication, Token Authentication
|
267
|
+
|
268
|
+
### HTTP request headers
|
269
|
+
|
270
|
+
- **Content-Type**: Not defined
|
271
|
+
- **Accept**: application/json
|
272
|
+
|
273
|
+
|
274
|
+
## datacenters_lans_nics_find_by_id
|
275
|
+
|
276
|
+
> <Nic> datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts)
|
277
|
+
|
278
|
+
Retrieve a nic attached to lan
|
279
|
+
|
280
|
+
This will retrieve the properties of an attached network interface.
|
281
|
+
|
282
|
+
### Examples
|
283
|
+
|
284
|
+
```ruby
|
285
|
+
require 'time'
|
286
|
+
require 'ionoscloud'
|
287
|
+
# setup authorization
|
288
|
+
Ionoscloud.configure do |config|
|
289
|
+
# Configure HTTP basic authorization: Basic Authentication
|
290
|
+
config.username = 'YOUR USERNAME'
|
291
|
+
config.password = 'YOUR PASSWORD'
|
292
|
+
|
293
|
+
# Configure API key authorization: Token Authentication
|
294
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
295
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
296
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
297
|
+
end
|
298
|
+
|
299
|
+
api_instance = Ionoscloud::LansApi.new
|
300
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
301
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
302
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
303
|
+
opts = {
|
304
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
305
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
306
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
307
|
+
}
|
308
|
+
|
309
|
+
begin
|
310
|
+
# Retrieve a nic attached to lan
|
311
|
+
result = api_instance.datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts)
|
312
|
+
p result
|
313
|
+
rescue Ionoscloud::ApiError => e
|
314
|
+
puts "Error when calling LansApi->datacenters_lans_nics_find_by_id: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
#### Using the datacenters_lans_nics_find_by_id_with_http_info variant
|
319
|
+
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
321
|
+
|
322
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts)
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
begin
|
326
|
+
# Retrieve a nic attached to lan
|
327
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts)
|
328
|
+
p status_code # => 2xx
|
329
|
+
p headers # => { ... }
|
330
|
+
p data # => <Nic>
|
331
|
+
rescue Ionoscloud::ApiError => e
|
332
|
+
puts "Error when calling LansApi->datacenters_lans_nics_find_by_id_with_http_info: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### Parameters
|
337
|
+
|
338
|
+
| Name | Type | Description | Notes |
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
340
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
341
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
342
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
343
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
344
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
345
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
346
|
+
|
347
|
+
### Return type
|
348
|
+
|
349
|
+
[**Nic**](Nic.md)
|
350
|
+
|
351
|
+
### Authorization
|
352
|
+
|
353
|
+
Basic Authentication, Token Authentication
|
354
|
+
|
355
|
+
### HTTP request headers
|
356
|
+
|
357
|
+
- **Content-Type**: Not defined
|
358
|
+
- **Accept**: application/json
|
359
|
+
|
360
|
+
|
361
|
+
## datacenters_lans_nics_get
|
362
|
+
|
363
|
+
> <LanNics> datacenters_lans_nics_get(datacenter_id, lan_id, opts)
|
364
|
+
|
365
|
+
List Lan Members
|
366
|
+
|
367
|
+
You can retrieve a list of nics attached to a LAN.
|
368
|
+
|
369
|
+
### Examples
|
370
|
+
|
371
|
+
```ruby
|
372
|
+
require 'time'
|
373
|
+
require 'ionoscloud'
|
374
|
+
# setup authorization
|
375
|
+
Ionoscloud.configure do |config|
|
376
|
+
# Configure HTTP basic authorization: Basic Authentication
|
377
|
+
config.username = 'YOUR USERNAME'
|
378
|
+
config.password = 'YOUR PASSWORD'
|
379
|
+
|
380
|
+
# Configure API key authorization: Token Authentication
|
381
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
382
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
383
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
384
|
+
end
|
385
|
+
|
386
|
+
api_instance = Ionoscloud::LansApi.new
|
387
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
388
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
389
|
+
opts = {
|
390
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
391
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
392
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
393
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
|
394
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
395
|
+
}
|
396
|
+
|
397
|
+
begin
|
398
|
+
# List Lan Members
|
399
|
+
result = api_instance.datacenters_lans_nics_get(datacenter_id, lan_id, opts)
|
400
|
+
p result
|
401
|
+
rescue Ionoscloud::ApiError => e
|
402
|
+
puts "Error when calling LansApi->datacenters_lans_nics_get: #{e}"
|
403
|
+
end
|
404
|
+
```
|
405
|
+
|
406
|
+
#### Using the datacenters_lans_nics_get_with_http_info variant
|
407
|
+
|
408
|
+
This returns an Array which contains the response data, status code and headers.
|
409
|
+
|
410
|
+
> <Array(<LanNics>, Integer, Hash)> datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts)
|
411
|
+
|
412
|
+
```ruby
|
413
|
+
begin
|
414
|
+
# List Lan Members
|
415
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts)
|
416
|
+
p status_code # => 2xx
|
417
|
+
p headers # => { ... }
|
418
|
+
p data # => <LanNics>
|
419
|
+
rescue Ionoscloud::ApiError => e
|
420
|
+
puts "Error when calling LansApi->datacenters_lans_nics_get_with_http_info: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
| Name | Type | Description | Notes |
|
427
|
+
| ---- | ---- | ----------- | ----- |
|
428
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
429
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
430
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
431
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
432
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
433
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
|
434
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
435
|
+
|
436
|
+
### Return type
|
437
|
+
|
438
|
+
[**LanNics**](LanNics.md)
|
439
|
+
|
440
|
+
### Authorization
|
441
|
+
|
442
|
+
Basic Authentication, Token Authentication
|
443
|
+
|
444
|
+
### HTTP request headers
|
445
|
+
|
446
|
+
- **Content-Type**: Not defined
|
447
|
+
- **Accept**: application/json
|
448
|
+
|
449
|
+
|
450
|
+
## datacenters_lans_nics_post
|
451
|
+
|
452
|
+
> <Nic> datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts)
|
453
|
+
|
454
|
+
Attach a nic
|
455
|
+
|
456
|
+
This will attach a pre-existing nic to a LAN.
|
457
|
+
|
458
|
+
### Examples
|
459
|
+
|
460
|
+
```ruby
|
461
|
+
require 'time'
|
462
|
+
require 'ionoscloud'
|
463
|
+
# setup authorization
|
464
|
+
Ionoscloud.configure do |config|
|
465
|
+
# Configure HTTP basic authorization: Basic Authentication
|
466
|
+
config.username = 'YOUR USERNAME'
|
467
|
+
config.password = 'YOUR PASSWORD'
|
468
|
+
|
469
|
+
# Configure API key authorization: Token Authentication
|
470
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
471
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
472
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
473
|
+
end
|
474
|
+
|
475
|
+
api_instance = Ionoscloud::LansApi.new
|
476
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
477
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
478
|
+
nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | Nic to be attached
|
479
|
+
opts = {
|
480
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
481
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
482
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
483
|
+
}
|
484
|
+
|
485
|
+
begin
|
486
|
+
# Attach a nic
|
487
|
+
result = api_instance.datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts)
|
488
|
+
p result
|
489
|
+
rescue Ionoscloud::ApiError => e
|
490
|
+
puts "Error when calling LansApi->datacenters_lans_nics_post: #{e}"
|
491
|
+
end
|
492
|
+
```
|
493
|
+
|
494
|
+
#### Using the datacenters_lans_nics_post_with_http_info variant
|
495
|
+
|
496
|
+
This returns an Array which contains the response data, status code and headers.
|
497
|
+
|
498
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts)
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
begin
|
502
|
+
# Attach a nic
|
503
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts)
|
504
|
+
p status_code # => 2xx
|
505
|
+
p headers # => { ... }
|
506
|
+
p data # => <Nic>
|
507
|
+
rescue Ionoscloud::ApiError => e
|
508
|
+
puts "Error when calling LansApi->datacenters_lans_nics_post_with_http_info: #{e}"
|
509
|
+
end
|
510
|
+
```
|
511
|
+
|
512
|
+
### Parameters
|
513
|
+
|
514
|
+
| Name | Type | Description | Notes |
|
515
|
+
| ---- | ---- | ----------- | ----- |
|
516
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
517
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
518
|
+
| **nic** | [**Nic**](Nic.md) | Nic to be attached | |
|
519
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
520
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
521
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
522
|
+
|
523
|
+
### Return type
|
524
|
+
|
525
|
+
[**Nic**](Nic.md)
|
526
|
+
|
527
|
+
### Authorization
|
528
|
+
|
529
|
+
Basic Authentication, Token Authentication
|
530
|
+
|
531
|
+
### HTTP request headers
|
532
|
+
|
533
|
+
- **Content-Type**: application/json
|
534
|
+
- **Accept**: application/json
|
535
|
+
|
536
|
+
|
537
|
+
## datacenters_lans_patch
|
538
|
+
|
539
|
+
> <Lan> datacenters_lans_patch(datacenter_id, lan_id, lan, opts)
|
540
|
+
|
541
|
+
Partially modify a Lan
|
542
|
+
|
543
|
+
You can use update attributes of a resource.
|
544
|
+
|
545
|
+
### Examples
|
546
|
+
|
547
|
+
```ruby
|
548
|
+
require 'time'
|
549
|
+
require 'ionoscloud'
|
550
|
+
# setup authorization
|
551
|
+
Ionoscloud.configure do |config|
|
552
|
+
# Configure HTTP basic authorization: Basic Authentication
|
553
|
+
config.username = 'YOUR USERNAME'
|
554
|
+
config.password = 'YOUR PASSWORD'
|
555
|
+
|
556
|
+
# Configure API key authorization: Token Authentication
|
557
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
558
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
559
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
560
|
+
end
|
561
|
+
|
562
|
+
api_instance = Ionoscloud::LansApi.new
|
563
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
564
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
565
|
+
lan = Ionoscloud::LanProperties.new # LanProperties | Modified Lan
|
566
|
+
opts = {
|
567
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
568
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
569
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
570
|
+
}
|
571
|
+
|
572
|
+
begin
|
573
|
+
# Partially modify a Lan
|
574
|
+
result = api_instance.datacenters_lans_patch(datacenter_id, lan_id, lan, opts)
|
575
|
+
p result
|
576
|
+
rescue Ionoscloud::ApiError => e
|
577
|
+
puts "Error when calling LansApi->datacenters_lans_patch: #{e}"
|
578
|
+
end
|
579
|
+
```
|
580
|
+
|
581
|
+
#### Using the datacenters_lans_patch_with_http_info variant
|
582
|
+
|
583
|
+
This returns an Array which contains the response data, status code and headers.
|
584
|
+
|
585
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts)
|
586
|
+
|
587
|
+
```ruby
|
588
|
+
begin
|
589
|
+
# Partially modify a Lan
|
590
|
+
data, status_code, headers = api_instance.datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts)
|
591
|
+
p status_code # => 2xx
|
592
|
+
p headers # => { ... }
|
593
|
+
p data # => <Lan>
|
594
|
+
rescue Ionoscloud::ApiError => e
|
595
|
+
puts "Error when calling LansApi->datacenters_lans_patch_with_http_info: #{e}"
|
596
|
+
end
|
597
|
+
```
|
598
|
+
|
599
|
+
### Parameters
|
600
|
+
|
601
|
+
| Name | Type | Description | Notes |
|
602
|
+
| ---- | ---- | ----------- | ----- |
|
603
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
604
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
605
|
+
| **lan** | [**LanProperties**](LanProperties.md) | Modified Lan | |
|
606
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
607
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
608
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
609
|
+
|
610
|
+
### Return type
|
611
|
+
|
612
|
+
[**Lan**](Lan.md)
|
613
|
+
|
614
|
+
### Authorization
|
615
|
+
|
616
|
+
Basic Authentication, Token Authentication
|
617
|
+
|
618
|
+
### HTTP request headers
|
619
|
+
|
620
|
+
- **Content-Type**: application/json
|
621
|
+
- **Accept**: application/json
|
622
|
+
|
623
|
+
|
624
|
+
## datacenters_lans_post
|
625
|
+
|
626
|
+
> <LanPost> datacenters_lans_post(datacenter_id, lan, opts)
|
627
|
+
|
628
|
+
Create a Lan
|
629
|
+
|
630
|
+
Creates a LAN within the datacenter.
|
631
|
+
|
632
|
+
### Examples
|
633
|
+
|
634
|
+
```ruby
|
635
|
+
require 'time'
|
636
|
+
require 'ionoscloud'
|
637
|
+
# setup authorization
|
638
|
+
Ionoscloud.configure do |config|
|
639
|
+
# Configure HTTP basic authorization: Basic Authentication
|
640
|
+
config.username = 'YOUR USERNAME'
|
641
|
+
config.password = 'YOUR PASSWORD'
|
642
|
+
|
643
|
+
# Configure API key authorization: Token Authentication
|
644
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
645
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
646
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
647
|
+
end
|
648
|
+
|
649
|
+
api_instance = Ionoscloud::LansApi.new
|
650
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
651
|
+
lan = Ionoscloud::LanPost.new({properties: Ionoscloud::LanPropertiesPost.new}) # LanPost | Lan to be created
|
652
|
+
opts = {
|
653
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
654
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
655
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
656
|
+
}
|
657
|
+
|
658
|
+
begin
|
659
|
+
# Create a Lan
|
660
|
+
result = api_instance.datacenters_lans_post(datacenter_id, lan, opts)
|
661
|
+
p result
|
662
|
+
rescue Ionoscloud::ApiError => e
|
663
|
+
puts "Error when calling LansApi->datacenters_lans_post: #{e}"
|
664
|
+
end
|
665
|
+
```
|
666
|
+
|
667
|
+
#### Using the datacenters_lans_post_with_http_info variant
|
668
|
+
|
669
|
+
This returns an Array which contains the response data, status code and headers.
|
670
|
+
|
671
|
+
> <Array(<LanPost>, Integer, Hash)> datacenters_lans_post_with_http_info(datacenter_id, lan, opts)
|
672
|
+
|
673
|
+
```ruby
|
674
|
+
begin
|
675
|
+
# Create a Lan
|
676
|
+
data, status_code, headers = api_instance.datacenters_lans_post_with_http_info(datacenter_id, lan, opts)
|
677
|
+
p status_code # => 2xx
|
678
|
+
p headers # => { ... }
|
679
|
+
p data # => <LanPost>
|
680
|
+
rescue Ionoscloud::ApiError => e
|
681
|
+
puts "Error when calling LansApi->datacenters_lans_post_with_http_info: #{e}"
|
682
|
+
end
|
683
|
+
```
|
684
|
+
|
685
|
+
### Parameters
|
686
|
+
|
687
|
+
| Name | Type | Description | Notes |
|
688
|
+
| ---- | ---- | ----------- | ----- |
|
689
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
690
|
+
| **lan** | [**LanPost**](LanPost.md) | Lan to be created | |
|
691
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
692
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
693
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
694
|
+
|
695
|
+
### Return type
|
696
|
+
|
697
|
+
[**LanPost**](LanPost.md)
|
698
|
+
|
699
|
+
### Authorization
|
700
|
+
|
701
|
+
Basic Authentication, Token Authentication
|
702
|
+
|
703
|
+
### HTTP request headers
|
704
|
+
|
705
|
+
- **Content-Type**: application/json
|
706
|
+
- **Accept**: application/json
|
707
|
+
|
708
|
+
|
709
|
+
## datacenters_lans_put
|
710
|
+
|
711
|
+
> <Lan> datacenters_lans_put(datacenter_id, lan_id, lan, opts)
|
712
|
+
|
713
|
+
Modify a Lan
|
714
|
+
|
715
|
+
You can use update attributes of a resource.
|
716
|
+
|
717
|
+
### Examples
|
718
|
+
|
719
|
+
```ruby
|
720
|
+
require 'time'
|
721
|
+
require 'ionoscloud'
|
722
|
+
# setup authorization
|
723
|
+
Ionoscloud.configure do |config|
|
724
|
+
# Configure HTTP basic authorization: Basic Authentication
|
725
|
+
config.username = 'YOUR USERNAME'
|
726
|
+
config.password = 'YOUR PASSWORD'
|
727
|
+
|
728
|
+
# Configure API key authorization: Token Authentication
|
729
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
730
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
731
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
732
|
+
end
|
733
|
+
|
734
|
+
api_instance = Ionoscloud::LansApi.new
|
735
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
736
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
737
|
+
lan = Ionoscloud::Lan.new({properties: Ionoscloud::LanProperties.new}) # Lan | Modified Lan
|
738
|
+
opts = {
|
739
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
740
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
|
741
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
|
742
|
+
}
|
743
|
+
|
744
|
+
begin
|
745
|
+
# Modify a Lan
|
746
|
+
result = api_instance.datacenters_lans_put(datacenter_id, lan_id, lan, opts)
|
747
|
+
p result
|
748
|
+
rescue Ionoscloud::ApiError => e
|
749
|
+
puts "Error when calling LansApi->datacenters_lans_put: #{e}"
|
750
|
+
end
|
751
|
+
```
|
752
|
+
|
753
|
+
#### Using the datacenters_lans_put_with_http_info variant
|
754
|
+
|
755
|
+
This returns an Array which contains the response data, status code and headers.
|
756
|
+
|
757
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts)
|
758
|
+
|
759
|
+
```ruby
|
760
|
+
begin
|
761
|
+
# Modify a Lan
|
762
|
+
data, status_code, headers = api_instance.datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts)
|
763
|
+
p status_code # => 2xx
|
764
|
+
p headers # => { ... }
|
765
|
+
p data # => <Lan>
|
766
|
+
rescue Ionoscloud::ApiError => e
|
767
|
+
puts "Error when calling LansApi->datacenters_lans_put_with_http_info: #{e}"
|
768
|
+
end
|
769
|
+
```
|
770
|
+
|
771
|
+
### Parameters
|
772
|
+
|
773
|
+
| Name | Type | Description | Notes |
|
774
|
+
| ---- | ---- | ----------- | ----- |
|
775
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
776
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
777
|
+
| **lan** | [**Lan**](Lan.md) | Modified Lan | |
|
778
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
779
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
|
780
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
|
781
|
+
|
782
|
+
### Return type
|
783
|
+
|
784
|
+
[**Lan**](Lan.md)
|
785
|
+
|
786
|
+
### Authorization
|
787
|
+
|
788
|
+
Basic Authentication, Token Authentication
|
789
|
+
|
790
|
+
### HTTP request headers
|
791
|
+
|
792
|
+
- **Content-Type**: application/json
|
793
|
+
- **Accept**: application/json
|
794
|
+
|