Package google.cloud.baremetalsolution.v2

Index

BareMetalSolution

Performs management operations on Bare Metal Solution servers.

The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Create an Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateNfsShare

rpc CreateNfsShare(CreateNfsShareRequest) returns (Operation)

Create an NFS share.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateVolumeSnapshot

rpc CreateVolumeSnapshot(CreateVolumeSnapshotRequest) returns (VolumeSnapshot)

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteNfsShare

rpc DeleteNfsShare(DeleteNfsShareRequest) returns (Operation)

Delete an NFS share. The underlying volume is automatically deleted.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteVolumeSnapshot

rpc DeleteVolumeSnapshot(DeleteVolumeSnapshotRequest) returns (Empty)

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DetachLun

rpc DetachLun(DetachLunRequest) returns (Operation)

Detach LUN from Instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
EvictLun

rpc EvictLun(EvictLunRequest) returns (Operation)

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
EvictVolume

rpc EvictVolume(EvictVolumeRequest) returns (Operation)

Skips volume's cooloff and deletes it now. Volume must be in cooloff state.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Get details about a single server.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetLun

rpc GetLun(GetLunRequest) returns (Lun)

Get details of a single storage logical unit number(LUN).

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetNetwork

rpc GetNetwork(GetNetworkRequest) returns (Network)

Get details of a single network.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetNfsShare

rpc GetNfsShare(GetNfsShareRequest) returns (NfsShare)

Get details of a single NFS share.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

Get details about an operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetVolume

rpc GetVolume(GetVolumeRequest) returns (Volume)

Get details of a single storage volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetVolumeSnapshot

rpc GetVolumeSnapshot(GetVolumeSnapshotRequest) returns (VolumeSnapshot)

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

List servers in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListLuns

rpc ListLuns(ListLunsRequest) returns (ListLunsResponse)

List storage volume luns for given storage volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListNetworks

rpc ListNetworks(ListNetworksRequest) returns (ListNetworksResponse)

List network in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListNfsShares

rpc ListNfsShares(ListNfsSharesRequest) returns (ListNfsSharesResponse)

List NFS shares.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListVolumeSnapshots

rpc ListVolumeSnapshots(ListVolumeSnapshotsRequest) returns (ListVolumeSnapshotsResponse)

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListVolumes

rpc ListVolumes(ListVolumesRequest) returns (ListVolumesResponse)

List storage volumes in a given project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
RenameInstance

rpc RenameInstance(RenameInstanceRequest) returns (Instance)

RenameInstance sets a new name for an instance.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
RestoreVolumeSnapshot

rpc RestoreVolumeSnapshot(RestoreVolumeSnapshotRequest) returns (Operation)

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Starts a server that was shutdown.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Stop a running server.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

Update details of a single server.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateNetwork

rpc UpdateNetwork(UpdateNetworkRequest) returns (Operation)

Update details of a single network.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateNfsShare

rpc UpdateNfsShare(UpdateNfsShareRequest) returns (Operation)

Update details of a single NFS share.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateVolume

rpc UpdateVolume(UpdateVolumeRequest) returns (Operation)

Update details of a single storage volume.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateInstanceRequest

Message to create a server.

Fields
parent

string

Required. The parent project and location.
instance

Instance

Required. The instance to create.

CreateNfsShareRequest

Message for creating an NFS share.

Fields
parent

string

Required. The parent project and location.
nfs_share

NfsShare

Required. The NfsShare to create.

CreateVolumeSnapshotRequest

Message for creating a volume snapshot.

Fields
parent

string

Required. The volume to snapshot.
volume_snapshot

VolumeSnapshot

Required. The snapshot to create.

DeleteNfsShareRequest

Message for deleting an NFS share.

Fields
name

string

Required. The name of the NFS share to delete.

DeleteVolumeSnapshotRequest

Message for deleting named Volume snapshot.

Fields
name

string

Required. The name of the snapshot to delete.

DetachLunRequest

Message for detach specific LUN from an Instance.

Fields
instance

string

Required. Name of the instance.
lun

string

Required. Name of the Lun to detach.
skip_reboot

bool

If true, performs lun unmapping without instance reboot.

EvictLunRequest

Request for skip lun cooloff and delete it.

Fields
name

string

Required. The name of the lun.

EvictVolumeRequest

Request for skip volume cooloff and delete it.

Fields
name

string

Required. The name of the Volume.

GetInstanceRequest

Message for requesting server information.

Fields
name

string

Required. Name of the resource.

GetLunRequest

Message for requesting storage lun information.

Fields
name

string

Required. Name of the resource.

GetNetworkRequest

Message for requesting network information.

Fields
name

string

Required. Name of the resource.

GetNfsShareRequest

Message for requesting NFS share information.

Fields
name

string

Required. Name of the resource.

GetVolumeRequest

Message for requesting storage volume information.

Fields
name

string

Required. Name of the resource.

GetVolumeSnapshotRequest

Message for requesting volume snapshot information.

Fields
name

string

Required. The name of the snapshot.

Instance

A server.

Fields
name

string

Immutable. 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}
id

string

Output only. An identifier for the Instance, generated by the backend.
create_time

Timestamp

Output only. Create a time stamp.
update_time

Timestamp

Output only. Update a time stamp.
machine_type

string

Immutable. The server type. Available server types
state

State

Output only. The state of the server.
hyperthreading_enabled

bool

True if you enable hyperthreading for the server, otherwise false. The default value is false.
labels

map<string, string>

Labels as key value pairs.
luns[]

Lun

Immutable. List of LUNs associated with this server.
volumes[]

Volume

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
networks[]

Network

Output only. List of networks associated with this server.
interactive_serial_console_enabled

bool

Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
os_image

string

The OS image currently installed on the server.
pod

string

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.
network_template

string

Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
logical_interfaces[]

LogicalInterface

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.
login_info

string

Output only. Text field about info for logging in.
workload_profile

WorkloadProfile

The workload profile for the instance.
firmware_version

string

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.

ListInstancesRequest

Message for requesting the list of servers.

Fields
parent

string

Required. Parent value for ListInstancesRequest.
page_size

int32

Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.
filter

string

List filter.

ListInstancesResponse

Response message for the list of servers.

Fields
instances[]

Instance

The list of servers.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

ListLunsRequest

Message for requesting a list of storage volume luns.

Fields
parent

string

Required. Parent value for ListLunsRequest.
page_size

int32

Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.

ListLunsResponse

Response message containing the list of storage volume luns.

Fields
luns[]

Lun

The list of luns.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

ListNetworksRequest

Message for requesting a list of networks.

Fields
parent

string

Required. Parent value for ListNetworksRequest.
page_size

int32

Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.
filter

string

List filter.

ListNetworksResponse

Response message containing the list of networks.

Fields
networks[]

Network

The list of networks.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

ListNfsSharesRequest

Message for requesting a list of NFS shares.

Fields
parent

string

Required. Parent value for ListNfsSharesRequest.
page_size

int32

Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.
filter

string

List filter.

ListNfsSharesResponse

Response message containing the list of NFS shares.

Fields
nfs_shares[]

NfsShare

The list of NFS shares.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

ListVolumeSnapshotsRequest

Message for requesting a list of volume snapshots.

Fields
parent

string

Required. Parent value for ListVolumesRequest.
page_size

int32

Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.

ListVolumeSnapshotsResponse

Response message containing the list of volume snapshots.

Fields
volume_snapshots[]

VolumeSnapshot

The list of snapshots.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

ListVolumesRequest

Message for requesting a list of storage volumes.

Fields
parent

string

Required. Parent value for ListVolumesRequest.
page_size

int32

Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

A token identifying a page of results from the server.
filter

string

List filter.

ListVolumesResponse

Response message containing the list of storage volumes.

Fields
volumes[]

Volume

The list of storage volumes.
next_page_token

string

A token identifying a page of results from the server.
unreachable[]

string

Locations that could not be reached.

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.

Fields
logical_network_interfaces[]

LogicalNetworkInterface

List of logical network interfaces within a logical interface.
name

string

Interface name. This is of syntax or and forms part of the network template name.
interface_index
(deprecated)

int32

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.

Fields
network

string

Name of the network
ip_address

string

IP address in the network
default_gateway

bool

Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
network_type

Type

Type of network.
id

string

An identifier for the Network, generated by the backend.

Lun

A storage volume logical unit number (LUN).

Fields
name

string

Output only. The name of the LUN.
id

string

An identifier for the LUN, generated by the backend.
state

State

The state of this storage volume.
size_gb

int64

The size of this LUN, in gigabytes.
multiprotocol_type

MultiprotocolType

The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
storage_volume

string

Display the storage volume for this LUN.
shareable

bool

Display if this LUN can be shared between multiple physical servers.
boot_lun

bool

Display if this LUN is a boot LUN.
storage_type

StorageType

The storage type for this LUN.
wwid

string

The WWID for this LUN.
expire_time

Timestamp

Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.

MultiprotocolType

Display the operating systems present for the LUN multiprotocol type.

Enums
MULTIPROTOCOL_TYPE_UNSPECIFIED Server has no OS specified.
LINUX Server with Linux OS.

State

The possible states for the LUN.

Enums
STATE_UNSPECIFIED The LUN is in an unknown state.
CREATING The LUN is being created.
UPDATING The LUN is being updated.
READY The LUN is ready for use.
DELETING The LUN has been requested to be deleted.
COOL_OFF The LUN is in cool off state. It will be deleted after expire_time.

StorageType

The storage types for a LUN.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this LUN is unknown.
SSD This storage type for this LUN is SSD.
HDD This storage type for this LUN is HDD.

Network

A Network.

Fields
name

string

Output 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}
id

string

An identifier for the Network, generated by the backend.
type

Type

The type of this network.
ip_address

string

IP address configured.
mac_address[]

string

List of physical interfaces.
state

State

The Network state.
vlan_id

string

The vlan id of the Network.
cidr

string

The cidr of the Network.
vrf

VRF

The vrf for the Network.
labels

map<string, string>

Labels as key value pairs.
services_cidr

string

IP range for reserved for services (e.g. NFS).
reservations[]

NetworkAddressReservation

List 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.
pod

string

Output only. Pod name.
mount_points[]

NetworkMountPoint

Input only. List of mount points to attach the network to.
jumbo_frames_enabled

bool

Whether network uses standard frames or jumbo ones.
gateway_ip

string

Output only. Gateway ip address.

State

The possible states for this Network.

Enums
STATE_UNSPECIFIED The Network is in an unknown state.
PROVISIONING The Network is provisioning.
PROVISIONED The Network has been provisioned.
DEPROVISIONING The Network is being deprovisioned.
UPDATING The Network is being updated.

Type

Network type.

Enums
TYPE_UNSPECIFIED Unspecified value.
CLIENT Client network, a network peered to a Google Cloud VPC.
PRIVATE Private network, a network local to the Bare Metal Solution environment.

NetworkAddressReservation

A reservation of one or more addresses in a network.

Fields
start_address

string

The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
end_address

string

The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
note

string

A note about this reservation, intended for human consumption.

NetworkMountPoint

Mount point for a network.

Fields
instance

string

Instance to attach network to.
logical_interface

string

Logical interface to detach from.
default_gateway

bool

Network should be a default gateway.
ip_address

string

Ip address of the server.

NfsShare

An NFS share.

Fields
name

string

Immutable. The name of the NFS share.
nfs_share_id

string

Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use id instead.
id

string

Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
state

State

Output only. The state of the NFS share.
volume

string

Output only. The underlying volume of the share. Created automatically during provisioning.
allowed_clients[]

AllowedClient

List of allowed access points.
labels

map<string, string>

Labels as key value pairs.
requested_size_gib

int64

The requested size, in GiB.
storage_type

StorageType

Immutable. The storage type of the underlying volume.

AllowedClient

Represents an 'access point' for the share.

Fields
network

string

The network the access point sits on.
share_ip

string

Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
allowed_clients_cidr

string

The subnet of IP addresses permitted to access the share.
mount_permissions

MountPermissions

Mount permissions.
allow_dev

bool

Allow dev flag. Which controls whether to allow creation of devices.
allow_suid

bool

Allow the setuid flag.
no_root_squash

bool

Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
nfs_path

string

Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"

MountPermissions

The possible mount permissions.

Enums
MOUNT_PERMISSIONS_UNSPECIFIED Permissions were not specified.
READ NFS share can be mount with read-only permissions.
READ_WRITE NFS share can be mount with read-write permissions.

State

The possible states for this NFS share.

Enums
STATE_UNSPECIFIED The share is in an unknown state.
PROVISIONED The share has been provisioned.
CREATING The NFS Share is being created.
UPDATING The NFS Share is being updated.
DELETING The NFS Share has been requested to be deleted.

StorageType

The storage type for a volume.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this volume is unknown.
SSD The storage type for this volume is SSD.
HDD This storage type for this volume is HDD.

OperationMetadata

Represents the metadata from a long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the action executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user requested the cancellation of the operation. Operations that have been successfully cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used with the operation.

RenameInstanceRequest

Message requesting rename of a server.

Fields
name

string

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}
new_name

string

Required. The new name of the instance. Format: {instancename}

ResetInstanceRequest

Message requesting to reset a server.

Fields
name

string

Required. Name of the resource.

RestoreVolumeSnapshotRequest

Message for restoring a volume snapshot.

Fields
volume_snapshot

string

Required. Name of the snapshot which will be used to restore its parent volume.

StartInstanceRequest

Message requesting to start a server.

Fields
name

string

Required. Name of the resource.

StopInstanceRequest

Message requesting to stop a server.

Fields
name

string

Required. Name of the resource.

UpdateInstanceRequest

Message requesting to updating a server.

Fields
instance

Instance

Required. The server to update.

The name field is used to identify the instance to update. Format: projects/{project}/locations/{location}/instances/{instance}
update_mask

FieldMask

The list of fields to update. The currently supported fields are: labels hyperthreading_enabled os_image

UpdateNetworkRequest

Message requesting to updating a network.

Fields
network

Network

Required. The network to update.

The name field is used to identify the instance to update. Format: projects/{project}/locations/{location}/networks/{network}
update_mask

FieldMask

The list of fields to update. The only currently supported fields are: labels, reservations, vrf.vlan_attachments

UpdateNfsShareRequest

Message requesting to updating an NFS share.

Fields
nfs_share

NfsShare

Required. The NFS share to update.

The name field is used to identify the NFS share to update. Format: projects/{project}/locations/{location}/nfsShares/{nfs_share}
update_mask

FieldMask

The list of fields to update. The only currently supported fields are: labels allowed_clients

UpdateVolumeRequest

Message for updating a volume.

Fields
volume

Volume

Required. The volume to update.

The name field is used to identify the volume to update. Format: projects/{project}/locations/{location}/volumes/{volume}
update_mask

FieldMask

The list of fields to update. The only currently supported fields are: 'labels'

VRF

A network VRF.

Fields
name

string

The name of the VRF.
state

State

The possible state of VRF.
qos_policy

QosPolicy

The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
vlan_attachments[]

VlanAttachment

The list of VLAN attachments for the VRF.

QosPolicy

QOS policy parameters.

Fields
bandwidth_gbps

double

The bandwidth permitted by the QOS policy, in gbps.

State

The possible states for this VRF.

Enums
STATE_UNSPECIFIED The unspecified state.
PROVISIONING The vrf is provisioning.
PROVISIONED The vrf is provisioned.

VlanAttachment

VLAN attachment details.

Fields
peer_vlan_id

int64

The peer vlan ID of the attachment.
peer_ip

string

The peer IP of the attachment.
router_ip

string

The router IP of the attachment.
pairing_key

string

Input only. Pairing key.
qos_policy

QosPolicy

The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
id

string

Immutable. The identifier of the attachment within vrf.

Volume

A storage volume.

Fields
name

string

Output 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}
id

string

An identifier for the Volume, generated by the backend.
storage_type

StorageType

The storage type for this volume.
state

State

The state of this storage volume.
requested_size_gib

int64

The requested size of this storage volume, in GiB.
originally_requested_size_gib

int64

Originally requested size, in GiB.
current_size_gib

int64

The 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.
emergency_size_gib

int64

Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
max_size_gib

int64

Maximum size volume can be expanded to in case of evergency, in GiB.
auto_grown_size_gib

int64

The 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.
remaining_space_gib

int64

The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
snapshot_reservation_detail

SnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.
snapshot_auto_delete_behavior

SnapshotAutoDeleteBehavior

The behavior to use when snapshot reserved space is full.
snapshot_schedule_policy

string

The name of the snapshot schedule policy in use for this volume, if any.
labels

map<string, string>

Labels as key value pairs.
snapshot_enabled

bool

Whether snapshots are enabled.
pod

string

Immutable. Pod name.
protocol

Protocol

Output only. Storage protocol for the Volume.
boot_volume

bool

Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
performance_tier

VolumePerformanceTier

Immutable. Performance tier of the Volume. Default is SHARED.
notes

string

Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
workload_profile

WorkloadProfile

The workload profile for the volume.
storage_aggregate_pool

string

Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes.
expire_time

Timestamp

Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.

Protocol

Storage protocol.

Enums
PROTOCOL_UNSPECIFIED Value is not specified.
FIBRE_CHANNEL Fibre Channel protocol.
NFS NFS protocol means Volume is a NFS Share volume. Such volumes cannot be manipulated via Volumes API.

SnapshotAutoDeleteBehavior

The kinds of auto delete behavior to use when snapshot reserved space is full.

Enums
SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED The unspecified behavior.
DISABLED Don't delete any snapshots. This disables new snapshot creation, as long as the snapshot reserved space is full.
OLDEST_FIRST Delete the oldest snapshots first.
NEWEST_FIRST Delete the newest snapshots first.

SnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.

Fields
reserved_space_gib

int64

The space on this storage volume reserved for snapshots, shown in GiB.
reserved_space_used_percent

int32

The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
reserved_space_remaining_gib

int64

The amount, in GiB, of available space in this storage volume's reserved snapshot space.
reserved_space_percent

int32

Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.

State

The possible states for a storage volume.

Enums
STATE_UNSPECIFIED The storage volume is in an unknown state.
CREATING The storage volume is being created.
READY The storage volume is ready for use.
DELETING The storage volume has been requested to be deleted.
UPDATING The storage volume is being updated.
COOL_OFF The storage volume is in cool off state. It will be deleted after expire_time.

StorageType

The storage type for a volume.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this volume is unknown.
SSD The storage type for this volume is SSD.
HDD This storage type for this volume is HDD.

WorkloadProfile

The possible values for a workload profile.

Enums
WORKLOAD_PROFILE_UNSPECIFIED The workload profile is in an unknown state.
GENERIC The workload profile is generic.
HANA The workload profile is hana.

VolumePerformanceTier

Performance tier of the Volume.

Enums
VOLUME_PERFORMANCE_TIER_UNSPECIFIED Value is not specified.
VOLUME_PERFORMANCE_TIER_SHARED Regular volumes, shared aggregates.
VOLUME_PERFORMANCE_TIER_ASSIGNED Assigned aggregates.
VOLUME_PERFORMANCE_TIER_HT High throughput aggregates.

VolumeSnapshot

A snapshot of a volume. Only boot volumes can have snapshots.

Fields
name

string

The name of the snapshot.
id

string

Output only. An identifier for the snapshot, generated by the backend.
description

string

The description of the snapshot.
create_time

Timestamp

Output only. The creation time of the snapshot.
storage_volume

string

Output only. The name of the volume which this snapshot belongs to.
type

SnapshotType

Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.

SnapshotType

Represents the type of a snapshot.

Enums
SNAPSHOT_TYPE_UNSPECIFIED Type is not specified.
AD_HOC Snapshot was taken manually by user.
SCHEDULED Snapshot was taken automatically as a part of a snapshot schedule.

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.