Show / Hide Table of Contents

Class DhcpOptionsConfig

A standalone, regional API resource that encapsulates a set of user-defined DHCP configurations.

Inheritance
object
DhcpOptionsConfig
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class DhcpOptionsConfig : IDirectResponseSchema

Properties

Associations

Mapping of user-defined keys to DhcpOptionsConfig to Network associations.

Declaration
[JsonProperty("associations")]
public virtual IDictionary<string, DhcpOptionsConfigAssociation> Associations { get; set; }
Property Value
Type Description
IDictionary<string, DhcpOptionsConfigAssociation>

BootFileIpv4Name

The file path and name of the boot image/file on the TFTP server that the client VM guest OS should download and execute during network boot. Used when the standard DHCP header 'file' field is overloaded. Corresponds to DHCPv4 Option 67.

Declaration
[JsonProperty("bootFileIpv4Name")]
public virtual string BootFileIpv4Name { get; set; }
Property Value
Type Description
string

BootFileIpv6Parameters

A list of UTF-8 encoded parameter strings to be passed as arguments to the bootloader program or OS kernel after downloading the boot file. Corresponds to DHCPv6 Option 60.

Declaration
[JsonProperty("bootFileIpv6Parameters")]
public virtual IList<string> BootFileIpv6Parameters { get; set; }
Property Value
Type Description
IList<string>

BootFileIpv6Url

The Uniform Resource Locator (URL) specifying the protocol, server address, and file path of the boot file that the client VM guest OS should download and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.

Declaration
[JsonProperty("bootFileIpv6Url")]
public virtual string BootFileIpv6Url { get; set; }
Property Value
Type Description
string

CreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

Description

An optional description of this resource. Provide this property when you create the resource.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DnsSearchPaths

An ordered list of domain suffixes (search paths) that the client VM guest OS should append to resolve hostnames that are not fully qualified. Applies to both DHCPv4 Option 119 and DHCPv6 Option 24.

Declaration
[JsonProperty("dnsSearchPaths")]
public virtual IList<string> DnsSearchPaths { get; set; }
Property Value
Type Description
IList<string>

DnsServerIpv4Addresses

An ordered list of IPv4 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv4 Option 6.

Declaration
[JsonProperty("dnsServerIpv4Addresses")]
public virtual IList<string> DnsServerIpv4Addresses { get; set; }
Property Value
Type Description
IList<string>

DnsServerIpv6Addresses

An ordered list of IPv6 addresses of DNS recursive name servers available to the client VM guest OS, specified in order of preference. Corresponds to DHCPv6 Option 23.

Declaration
[JsonProperty("dnsServerIpv6Addresses")]
public virtual IList<string> DnsServerIpv6Addresses { get; set; }
Property Value
Type Description
IList<string>

DomainName

The domain name that the client VM guest OS should use when resolving hostnames via DNS (e.g., 'example.com'). It defines the default domain suffix for the client. Corresponds to DHCPv4 Option 15.

Declaration
[JsonProperty("domainName")]
public virtual string DomainName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

Kind

Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LeaseTimeSec

The duration, in seconds, of the IPv4 address lease offered by the DHCP server to the client VM guest OS. Corresponds to DHCPv4 Option 51.

Declaration
[JsonProperty("leaseTimeSec")]
public virtual long? LeaseTimeSec { get; set; }
Property Value
Type Description
long?

Name

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NtpServerIpv4Addresses

An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization, listed in order of preference. Corresponds to DHCPv4 Option 42.

Declaration
[JsonProperty("ntpServerIpv4Addresses")]
public virtual IList<string> NtpServerIpv4Addresses { get; set; }
Property Value
Type Description
IList<string>

NtpServerIpv6Addresses

An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers available to the client VM guest OS for system clock synchronization. Corresponds to DHCPv6 Option 56.

Declaration
[JsonProperty("ntpServerIpv6Addresses")]
public virtual IList<string> NtpServerIpv6Addresses { get; set; }
Property Value
Type Description
IList<string>

Region

Output only. [Output Only] URL of the region where the resource resides.

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
string

SelfLink

Output only. [Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

TftpServerIpv4Addresses

An ordered list of one or more IPv4 addresses of TFTP servers. Provides server redundancy and failover support, and is generally prioritized by clients over the single hostname specified in Option 66. Corresponds to DHCPv4 Option 150.

Declaration
[JsonProperty("tftpServerIpv4Addresses")]
public virtual IList<string> TftpServerIpv4Addresses { get; set; }
Property Value
Type Description
IList<string>

TftpServerIpv4Name

The hostname or IP address of the Trivial File Transfer Protocol (TFTP) server from which the client VM guest OS can download boot files. Typically used in network booting (PXE) when the standard DHCP header 'sname' field is overloaded. Corresponds to DHCPv4 Option 66.

Declaration
[JsonProperty("tftpServerIpv4Name")]
public virtual string TftpServerIpv4Name { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX