Class BareMetalServer
java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.BareMetalServer
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class BareMetalServer
extends com.ibm.cloud.sdk.core.service.model.GenericModel
BareMetalServer.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state.static interface
The lifecycle state of the bare metal server.static interface
The resource type.static interface
The status of this bare metal server: - `deleting`: server is undergoing deletion - `failed`: server is failed and not usable (see `status_reasons`) - `maintenance`: server is undergoing maintenance (not usable) - `pending`: server is being provisioned and not yet usable - `reinitializing`: server is reinitializing and not yet usable - `restarting`: server is restarting and not yet usable - `running`: server is powered on - `starting`: server is starting and not yet usable - `stopped`: server is powered off The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future. -
Method Summary
Modifier and TypeMethodDescriptionGets the bandwidth.Gets the bootTarget.getCpu()
Gets the cpu.Gets the createdAt.getCrn()
Gets the crn.getDisks()
Gets the disks.Gets the firmware.Gets the healthReasons.Gets the healthState.getHref()
Gets the href.getId()
Gets the id.Gets the lifecycleReasons.Gets the lifecycleState.Gets the memory.getName()
Gets the name.Gets the networkAttachments.Gets the networkInterfaces.Gets the primaryNetworkAttachment.Gets the primaryNetworkInterface.Gets the profile.Gets the reservation.Gets the reservationAffinity.Gets the resourceGroup.Gets the resourceType.Gets the status.Gets the statusReasons.Gets the trustedPlatformModule.getVpc()
Gets the vpc.getZone()
Gets the zone.Gets the enableSecureBoot.Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString
-
Method Details
-
getBandwidth
Gets the bandwidth. The total bandwidth (in megabits per second) shared across the bare metal server network attachments or bare metal server network interfaces.- Returns:
- the bandwidth
-
getBootTarget
Gets the bootTarget. The resource from which this bare metal server is booted. The resources supported by this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.- Returns:
- the bootTarget
-
getCpu
Gets the cpu. The bare metal server CPU configuration.- Returns:
- the cpu
-
getCreatedAt
Gets the createdAt. The date and time that the bare metal server was created.- Returns:
- the createdAt
-
getCrn
-
getDisks
Gets the disks. The disks for this bare metal server, including any disks that are associated with the `boot_target`.- Returns:
- the disks
-
isEnableSecureBoot
Gets the enableSecureBoot. Indicates whether secure boot is enabled. If enabled, the image must support secure boot or the server will fail to boot.- Returns:
- the enableSecureBoot
-
getFirmware
Gets the firmware. Firmware information for the bare metal server.- Returns:
- the firmware
-
getHealthReasons
Gets the healthReasons. The reasons for the current server `health_state` (if any): - `reservation_capacity_unavailable`: The reservation affinity pool has no available capacity. - `reservation_deleted`: The reservation affinity pool has a deleted reservation. - `reservation_expired`: The reservation affinity pool has an expired reservation. - `reservation_failed`: The reservation affinity pool has a failed reservation. See [health status reasons](https://cloud.ibm.com/docs/vpc?topic=vpc-server-health-status-reasons) for details. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.- Returns:
- the healthReasons
-
getHealthState
Gets the healthState. The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.- Returns:
- the healthState
-
getHref
-
getId
Gets the id. The unique identifier for this bare metal server.- Returns:
- the id
-
getLifecycleReasons
Gets the lifecycleReasons. The reasons for the current `lifecycle_state` (if any).- Returns:
- the lifecycleReasons
-
getLifecycleState
Gets the lifecycleState. The lifecycle state of the bare metal server.- Returns:
- the lifecycleState
-
getMemory
Gets the memory. The amount of memory, truncated to whole gibibytes.- Returns:
- the memory
-
getName
Gets the name. The name for this bare metal server. The name is unique across all bare metal servers in the region.- Returns:
- the name
-
getNetworkAttachments
Gets the networkAttachments. The network attachments for this bare metal server, including the primary network attachment.- Returns:
- the networkAttachments
-
getNetworkInterfaces
Gets the networkInterfaces. The network interfaces for this bare metal server, including the primary network interface. If this bare metal server has network attachments, each network interface is a [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding network attachment and its attached virtual network interface.- Returns:
- the networkInterfaces
-
getPrimaryNetworkAttachment
Gets the primaryNetworkAttachment. The primary network attachment for this bare metal server.- Returns:
- the primaryNetworkAttachment
-
getPrimaryNetworkInterface
Gets the primaryNetworkInterface. The primary network interface for this bare metal server. If this bare metal server has network attachments, this primary network interface is a [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of the primary network attachment and its attached virtual network interface.- Returns:
- the primaryNetworkInterface
-
getProfile
Gets the profile. The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-bare-metal-servers-profile) for this bare metal server.- Returns:
- the profile
-
getReservation
Gets the reservation. The reservation used by this bare metal server. If absent, no reservation is in use.- Returns:
- the reservation
-
getReservationAffinity
Gets the reservationAffinity.- Returns:
- the reservationAffinity
-
getResourceGroup
Gets the resourceGroup. The resource group for this bare metal server.- Returns:
- the resourceGroup
-
getResourceType
-
getStatus
Gets the status. The status of this bare metal server: - `deleting`: server is undergoing deletion - `failed`: server is failed and not usable (see `status_reasons`) - `maintenance`: server is undergoing maintenance (not usable) - `pending`: server is being provisioned and not yet usable - `reinitializing`: server is reinitializing and not yet usable - `restarting`: server is restarting and not yet usable - `running`: server is powered on - `starting`: server is starting and not yet usable - `stopped`: server is powered off The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.- Returns:
- the status
-
getStatusReasons
Gets the statusReasons. The reasons for the current status (if any).- Returns:
- the statusReasons
-
getTrustedPlatformModule
Gets the trustedPlatformModule.- Returns:
- the trustedPlatformModule
-
getVpc
Gets the vpc. The VPC this bare metal server resides in.- Returns:
- the vpc
-
getZone
Gets the zone. The zone this bare metal server resides in.- Returns:
- the zone
-