BareMetal API, gRPC: VrfService.UpdateVrf

Field

Description

vrf

Vrf

The vrf object to be updated.

update_mask

google.protobuf.FieldMask

Fields to update.
google.protobuf.FieldMask google.protobuf.FieldMask. Updatable fields:

• name
• description
• static_routes
• labels

Field

Description

vrf_id

string

ID of the VRF.

cloud_id

string

ID of the cloud that the private subnet belongs to.

folder_id

string

ID of the folder that the private subnet belongs to.

name

string

Name of the VRF. Unique within the folder.

The string length in characters must be 2-63. Value must match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.

description

string

Optional description of the VRF.

The maximum string length in characters is 1024.

state

enum State

State of the VRF.

• ACTIVE: VRF is ready to use.
• UPDATING: VRF is being updated.

static_routes[]

StaticRoute

Static routes.

create_time

google.protobuf.Timestamp

Creation timestamp.

update_time

google.protobuf.Timestamp

Last update timestamp.

annotations

object (map<string, string>)

Resource annotations as key:value pairs.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. Each value must match the regular expression [-_0-9a-z]*. No more than 64 per resource.

Field

Description

destination_cidr

string

Destination network CIDR block.

next_hop_ip_address

string

Next hop host IP address.

redistribution_type

enum RedistributionType

Redistribution type.

• DISABLED: Static route announcements outside BareMetal VRF disabled.
• ENABLED: Static route announcements outside BareMetal VRF enabled.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.