Skip to main content

instances

Overview

Nameinstances
TypeResource
Idgoogle.baremetalsolution.instances

Fields

NameDatatypeDescription
idstringOutput only. An identifier for the Instance, generated by the backend.
namestringImmutable. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}
interactiveSerialConsoleEnabledbooleanOutput only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
workloadProfilestringThe workload profile for the instance.
hyperthreadingEnabledbooleanTrue if you enable hyperthreading for the server, otherwise false. The default value is false.
osImagestringThe OS image currently installed on the server.
loginInfostringOutput only. Text field about info for logging in.
labelsobjectLabels as key value pairs.
createTimestringOutput only. Create a time stamp.
logicalInterfacesarrayList 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.
firmwareVersionstringOutput only. The firmware version for the instance.
lunsarrayImmutable. List of LUNs associated with this server.
networksarrayOutput only. List of networks associated with this server.
updateTimestringOutput only. Update a time stamp.
volumesarrayInput only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
machineTypestringImmutable. The server type. Available server types
statestringOutput only. The state of the server.
podstringImmutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
networkTemplatestringInstance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".

Methods

NameAccessible byRequired ParamsDescription
getSELECTinstancesId, locationsId, projectsIdGet details about a single server.
listSELECTlocationsId, projectsIdList servers in a given project and location.
_listEXEClocationsId, projectsIdList servers in a given project and location.
detach_lunEXECinstancesId, locationsId, projectsIdDetach LUN from Instance.
disable_interactive_serial_consoleEXECinstancesId, locationsId, projectsIdDisable the interactive serial console feature on an instance.
enable_interactive_serial_consoleEXECinstancesId, locationsId, projectsIdEnable the interactive serial console feature on an instance.
patchEXECinstancesId, locationsId, projectsIdUpdate details of a single server.
renameEXECinstancesId, locationsId, projectsIdRenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.
resetEXECinstancesId, locationsId, projectsIdPerform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
startEXECinstancesId, locationsId, projectsIdStarts a server that was shutdown.
stopEXECinstancesId, locationsId, projectsIdStop a running server.