BareMetal API, gRPC: PrivateSubnetService.Create

Field

Description

name

string

Name of the private subnet.
The name must be 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

Description of the private subnet.

The maximum string length in characters is 1024.

hardware_pool_id

string

ID of the hardware pool where the private subnet resides.
To get a list of available hardware pools, use the HardwarePoolService.List request.

The maximum string length in characters is 20.

vrf_options_spec

VrfOptionsSpec

VRF options. Optional.

folder_id

string

ID of the folder to create a private subnet in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9.-]*.

labels

object (map<string, string>)

Resource labels 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

vrf_id

string

ID of the VRF to create private subnet in.
To get the VRF ID, use a VrfService.List request.

cidr

string

CIDR block.
The range of internal addresses that are defined for this private subnet, as
specified in RFC1918.
For example, 10.0.0.0/22 or 192.168.0.0/24.

dhcp_options

DhcpOptionsSpec

DHCP options for the subnet.
The absence or null value indicates that DHCP is disabled.

gateway_ip

string

Gateway IP address for the subnet.

Field

Description

start_ip

string

Start IP address of the DHCP range (inclusive).
The absence or null value indicates that calculation will be performed based on CIDR.

end_ip

string

End IP address of the DHCP range (inclusive).
The absence or null value indicates that calculation will be performed based on CIDR.

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.