Skip to main content
← back to extensions

@swamp/gcp/baremetalsolution

v2026.04.23.1

Google Cloud baremetalsolution infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudbaremetalsolutioncloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/baremetalsolution

@swamp/gcp/baremetalsolution/instancesv2026.04.23.1instances.ts

Global Arguments

ArgumentTypeDescription
createTime?stringOutput only. Create a time stamp.
firmwareVersion?stringOutput only. The firmware version for the instance.
hyperthreadingEnabled?booleanTrue if you enable hyperthreading for the server, otherwise false. The default value is false.
id?stringOutput only. An identifier for the `Instance`, generated by the backend.
interactiveSerialConsoleEnabled?booleanOutput only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
kmsKeyVersion?stringOptional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
labels?recordLabels as key value pairs.
logicalInterfaces?arrayList 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?stringOutput only. Text field about info for logging in.
luns?arrayImmutable. List of LUNs associated with this server.
machineType?stringImmutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
name?stringImmutable. 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}`
networkTemplate?stringInstance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
networks?arrayOutput only. List of networks associated with this server.
osImage?stringThe OS image currently installed on the server.
pod?stringImmutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
sshKeys?arrayOptional. List of SSH Keys used during instance provisioning.
state?enumOutput only. The state of the server.
updateTime?stringOutput only. Update a time stamp.
volumes?arrayInput only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
workloadProfile?enumThe workload profile for the instance.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
updateUpdate instances attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync instances state from GCP
detach_lundetach lun
ArgumentTypeDescription
lun?any
skipReboot?any
disable_hyperthreadingdisable hyperthreading
disable_interactive_serial_consoledisable interactive serial console
enable_hyperthreadingenable hyperthreading
enable_interactive_serial_consoleenable interactive serial console
load_auth_infoload auth info
reimagereimage
ArgumentTypeDescription
kmsKeyVersion?any
osImage?any
sshKeys?any
renamerename
ArgumentTypeDescription
newInstanceId?any
resetreset
startstart
stopstop

Resources

state(infinite)— A server.
@swamp/gcp/baremetalsolution/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/baremetalsolution/networksv2026.04.23.1networks.ts

Global Arguments

ArgumentTypeDescription
cidr?stringThe cidr of the Network.
gatewayIp?stringOutput only. Gateway ip address.
id?stringAn identifier for the `Network`, generated by the backend.
ipAddress?stringIP address configured.
jumboFramesEnabled?booleanWhether network uses standard frames or jumbo ones.
labels?recordLabels as key value pairs.
macAddress?arrayList of physical interfaces.
mountPoints?arrayInput only. List of mount points to attach the network to.
name?stringOutput only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
pod?stringImmutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
reservations?arrayList of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
servicesCidr?stringIP range for reserved for services (e.g. NFS).
state?enumThe Network state.
type?enumThe type of this network.
vlanId?stringThe vlan id of the Network.
vrf?objectA network VRF.
vrfAttachment?stringOptional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a networks
ArgumentTypeDescription
identifierstringThe name of the networks
updateUpdate networks attributes
syncSync networks state from GCP
list_network_usagelist network usage
renamerename
ArgumentTypeDescription
newNetworkId?any

Resources

state(infinite)— A Network.
@swamp/gcp/baremetalsolution/nfssharesv2026.04.23.1nfsshares.ts

Global Arguments

ArgumentTypeDescription
allowedClients?arrayList of allowed access points.
labels?recordLabels as key value pairs.
name?stringImmutable. The name of the NFS share.
pod?stringImmutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
requestedSizeGib?stringThe requested size, in GiB.
storageType?enumImmutable. The storage type of the underlying volume.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a nfsShares
getGet a nfsShares
ArgumentTypeDescription
identifierstringThe name of the nfsShares
updateUpdate nfsShares attributes
deleteDelete the nfsShares
ArgumentTypeDescription
identifierstringThe name of the nfsShares
syncSync nfsShares state from GCP
renamerename
ArgumentTypeDescription
newNfsshareId?any

Resources

state(infinite)— An NFS share.
@swamp/gcp/baremetalsolution/osimagesv2026.04.23.1osimages.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a osImages
ArgumentTypeDescription
identifierstringThe name of the osImages
syncSync osImages state from GCP

Resources

state(infinite)— Operation System image.
@swamp/gcp/baremetalsolution/provisioningconfigsv2026.04.23.1provisioningconfigs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
customId?stringOptional. The user-defined identifier of the provisioning config.
handoverServiceAccount?stringA service account to enable customers to access instance credentials upon handover.
instances?arrayInstances to be created.
location?stringOptional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
networks?arrayNetworks to be created.
pod?stringOptional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
statusMessage?stringOptional status messages associated with the FAILED state.
ticketId?stringA generated ticket id to track provisioning request.
volumes?arrayVolumes to be created.
vpcScEnabled?booleanIf true, VPC SC is enabled for the cluster.
createCreate a provisioningConfigs
getGet a provisioningConfigs
ArgumentTypeDescription
identifierstringThe name of the provisioningConfigs
updateUpdate provisioningConfigs attributes
syncSync provisioningConfigs state from GCP
submitsubmit
ArgumentTypeDescription
email?any
provisioningConfig?any

Resources

state(infinite)— A provisioning configuration.
@swamp/gcp/baremetalsolution/provisioningquotasv2026.04.23.1provisioningquotas.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a provisioningQuotas
ArgumentTypeDescription
identifierstringThe name of the provisioningQuotas
syncSync provisioningQuotas state from GCP

Resources

state(infinite)— A provisioning quota for a given project.
@swamp/gcp/baremetalsolution/sshkeysv2026.04.23.1sshkeys.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
publicKey?stringThe public SSH key. This must be in OpenSSH.authorized_keys format.
sshKeyId?stringRequired. The ID to use for the key, which will become the final component of the key's resource name. This value must match the regex: [a-zA-Z0-9@.\\-_]{1,64}
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a sshKeys
getGet a sshKeys
ArgumentTypeDescription
identifierstringThe name of the sshKeys
deleteDelete the sshKeys
ArgumentTypeDescription
identifierstringThe name of the sshKeys
syncSync sshKeys state from GCP

Resources

state(infinite)— An SSH key, used for authorizing with the interactive serial console feature.
@swamp/gcp/baremetalsolution/volumesv2026.04.23.1volumes.ts

Global Arguments

ArgumentTypeDescription
attached?booleanOutput only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.
autoGrownSizeGib?stringThe size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
bootVolume?booleanOutput only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
currentSizeGib?stringThe current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
emergencySizeGib?stringAdditional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
expireTime?stringOutput only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
id?stringAn identifier for the `Volume`, generated by the backend.
instances?arrayOutput only. Instances this Volume is attached to. This field is set only in Get requests.
labels?recordLabels as key value pairs.
maxSizeGib?stringMaximum size volume can be expanded to in case of evergency, in GiB.
name?stringOutput only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
notes?stringInput only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
originallyRequestedSizeGib?stringOriginally requested size, in GiB.
performanceTier?enumImmutable. Performance tier of the Volume. Default is SHARED.
pod?stringImmutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
protocol?enumOutput only. Storage protocol for the Volume.
remainingSpaceGib?stringThe space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
requestedSizeGib?stringThe requested size of this storage volume, in GiB.
snapshotAutoDeleteBehavior?enumThe behavior to use when snapshot reserved space is full.
snapshotEnabled?booleanWhether snapshots are enabled.
snapshotReservationDetail?objectDetails about snapshot space reservation and usage on the storage volume.
state?enumThe state of this storage volume.
storageType?enumThe storage type for this volume.
workloadProfile?enumThe workload profile for the volume.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a volumes
ArgumentTypeDescription
identifierstringThe name of the volumes
updateUpdate volumes attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync volumes state from GCP
evictevict
renamerename
ArgumentTypeDescription
newVolumeId?any
resizeresize
ArgumentTypeDescription
sizeGib?any

Resources

state(infinite)— A storage volume.
@swamp/gcp/baremetalsolution/volumes-lunsv2026.04.23.1volumes_luns.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a luns
ArgumentTypeDescription
identifierstringThe name of the luns
syncSync luns state from GCP
evictevict

Resources

state(infinite)— A storage volume logical unit number (LUN).
@swamp/gcp/baremetalsolution/volumes-snapshotsv2026.04.23.1volumes_snapshots.ts

Global Arguments

ArgumentTypeDescription
description?stringThe description of the snapshot.
name?stringThe name of the snapshot.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a snapshots
getGet a snapshots
ArgumentTypeDescription
identifierstringThe name of the snapshots
deleteDelete the snapshots
ArgumentTypeDescription
identifierstringThe name of the snapshots
syncSync snapshots state from GCP
restore_volume_snapshotrestore volume snapshot

Resources

state(infinite)— A snapshot of a volume. Only boot volumes can have snapshots.