Resource: Instance
A server.
JSON representation |
---|
{ "name": string, "id": string, "createTime": string, "updateTime": string, "machineType": string, "state": enum ( |
Fields | |
---|---|
name |
Immutable. The resource name of this |
id |
Output only. An identifier for the |
createTime |
Output only. Create a time stamp. |
updateTime |
Output only. Update a time stamp. |
machineType |
Immutable. The server type. Available server types |
state |
Output only. The state of the server. |
hyperthreadingEnabled |
True if you enable hyperthreading for the server, otherwise false. The default value is false. |
labels |
Labels as key value pairs. |
luns[] |
Immutable. List of LUNs associated with this server. |
volumes[] |
Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. |
networks[] |
Output only. List of networks associated with this server. |
interactiveSerialConsoleEnabled |
Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. |
osImage |
The OS image currently installed on the server. |
pod |
Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. |
networkTemplate |
Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond |
logicalInterfaces[] |
List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. |
loginInfo |
Output only. Text field about info for logging in. |
workloadProfile |
The workload profile for the instance. |
firmwareVersion |
Output only. The firmware version for the instance. |
State
The possible states for this server.
Enums | |
---|---|
STATE_UNSPECIFIED |
The server is in an unknown state. |
PROVISIONING |
The server is being provisioned. |
RUNNING |
The server is running. |
DELETED |
The server has been deleted. |
UPDATING |
The server is being updated. |
STARTING |
The server is starting. |
STOPPING |
The server is stopping. |
SHUTDOWN |
The server is shutdown. |
LogicalInterface
Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
JSON representation |
---|
{
"logicalNetworkInterfaces": [
{
object ( |
Fields | |
---|---|
logicalNetworkInterfaces[] |
List of logical network interfaces within a logical interface. |
name |
Interface name. This is of syntax |
interfaceIndex |
The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated. |
LogicalNetworkInterface
Each logical network interface is effectively a network and IP pair.
JSON representation |
---|
{
"network": string,
"ipAddress": string,
"defaultGateway": boolean,
"networkType": enum ( |
Fields | |
---|---|
network |
Name of the network |
ipAddress |
IP address in the network |
defaultGateway |
Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
networkType |
Type of network. |
id |
An identifier for the |
WorkloadProfile
The possible values for a workload profile.
Enums | |
---|---|
WORKLOAD_PROFILE_UNSPECIFIED |
The workload profile is in an unknown state. |
WORKLOAD_PROFILE_GENERIC |
The workload profile is generic. |
WORKLOAD_PROFILE_HANA |
The workload profile is hana. |
Methods |
|
---|---|
|
Create an Instance. |
|
Detach LUN from Instance. |
|
Get details about a single server. |
|
List servers in a given project and location. |
|
Update details of a single server. |
|
RenameInstance sets a new name for an instance. |
|
Perform an ungraceful, hard reset on a server. |
|
Starts a server that was shutdown. |
|
Stop a running server. |