Yandex Cloud
Search
Discuss with expertTry it for free
  • Customer Stories
  • Documentation
  • Blog
  • All Services
    • Cloud Interconnect
    • Cloud Backup
    • Cloud Registry
    • Yandex AI Studio
    • Compute Cloud
    • Object Storage
    • Managed Service for Kubernetes®
    • Yandex BareMetal
    • Smart Web Security
    • Security Deck
    • Managed Service for PostgreSQL
    • Managed Service for ClickHouse®
    • Monium
    • Cloud CDN
    • Network Load Balancer
    • Virtual Private Cloud
    • Cloud DNS
    • Application Load Balancer
    • Yandex Cloud Video
    • Stackland
    • Yandex Cloud Router
    • Yandex Managed Service for Trino
    • Managed Service for MySQL®
    • Managed Service for Valkey™
    • Managed Service for Apache Spark™
    • Yandex StoreDoc
    • Managed Service for OpenSearch
    • Managed Service for Apache Kafka®
    • Data Transfer
    • Yandex MPP Analytics Engine for PostgreSQL
    • Yandex Managed Service for Apache Airflow®
    • Data Processing
    • Yandex MetaData Hub
    • Managed Service for YDB
    • Managed Service for Sharded PostgreSQL
    • Managed Service for YTsaurus
    • Yandex WebSQL
    • DataLens
    • Yandex Search API
    • SpeechSense
    • SpeechKit
    • DataSphere
    • Vision OCR
    • Translate
    • Yandex Identity Hub
    • Key Management Service
    • Certificate Manager
    • Yandex Lockbox
    • Audit Trails
    • SmartCaptcha
    • Cloud Desktop
    • Yandex SIEM
    • SourceCraft Code Assistant
    • Container Registry
    • Managed Service for GitLab
    • Managed Service for Prometheus®
    • Cloud Functions
    • API Gateway
    • Yandex Cloud Postbox
    • Message Queue
    • Serverless Integrations
    • IoT Core
    • Data Streams
    • Serverless Containers
    • Cloud Notification Service
    • Yandex Query
    • Identity and Access Management
    • Yandex Cloud Console
    • Resource Manager
    • Yandex Cloud Billing
    • Yandex Cloud Quota Manager
    • Cloud Apps
  • System Status
  • Marketplace
    • Featured
    • Infrastructure & Network
    • Data Platform
    • AI for business
    • Security
    • DevOps tools
    • Serverless
    • Monitoring & Resources
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
    • Price calculator
    • Pricing plans
  • Customer Stories
  • Documentation
  • Blog
© 2026 Direct Cursus Technology L.L.C.
Yandex BareMetal
    • All guides
    • Overview
    • Integrations with other Yandex Cloud services
      • Overview
      • Stock server configurations
      • Custom server configuration
      • On-request server configuration
      • Overview
      • Public network
      • Private network
      • DHCP
      • MC-LAG
      • Restrictions in BareMetal networks
      • Overview
      • Images
      • Access management
      • Additional server settings
      • Management console
        • API authentication
            • Overview
              • Overview
              • GetVrf
              • ListVrfs
              • CreateVrf
              • UpdateVrf
              • DeleteVrf
              • ListVrfOperations
      • Monitoring metrics
    • Quotas and limits
  • Pricing policy
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetVrfRequest
  • Vrf
  • StaticRoute
  1. Concepts
  2. Setup and management
  3. API reference
  4. API v2
  5. gRPC
  6. Vrf
  7. GetVrf

BareMetal API, gRPC: VrfService.GetVrf

Written by
Yandex Cloud
Updated at September 1, 2026
View in Markdown
  • gRPC request
  • GetVrfRequest
  • Vrf
  • StaticRoute

Returns the specific VRF resource.

To get the list of available VRFs, make a [List] request.

gRPC requestgRPC request

rpc GetVrf (GetVrfRequest) returns (Vrf)

GetVrfRequestGetVrfRequest

{
  "cloud_id": "string",
  "folder_id": "string",
  "vrf_id": "string"
}

Field

Description

cloud_id

string

ID of the parent cloud.

To get the cloud ID, use a yandex.cloud.resourcemanager.v1.CloudService.List request.

folder_id

string

ID of the parent folder.

To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

vrf_id

string

ID of the VRF to return.

To get the VRF ID, use a [VrfService.List] request.

Value must match the regular expression [a-z][a-z0-9]*.

VrfVrf

{
  "vrf_id": "string",
  "cloud_id": "string",
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "state": "State",
  "static_routes": [
    {
      "destination_cidr": "string",
      "next_hop_ip_address": "string",
      "redistribution_type": "RedistributionType"
    }
  ],
  "create_time": "google.protobuf.Timestamp",
  "update_time": "google.protobuf.Timestamp",
  "annotations": "map<string, string>"
}

A VRF (Virtual Routing and Forwarding) resource.

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.

StaticRouteStaticRoute

A static route entry in a VRF.

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.

Was the article helpful?

Previous
Overview
Next
ListVrfs
© 2026 Direct Cursus Technology L.L.C.