Class DhcpOptionsConfig (0.12.7)

DhcpOptionsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
associations MutableMapping[str, google.cloud.compute_v1beta.types.DhcpOptionsConfigAssociation]
Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
boot_file_ipv4_name str
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. This field is a member of oneof_ _boot_file_ipv4_name.
boot_file_ipv6_parameters MutableSequence[str]
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.
boot_file_ipv6_url str
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. This field is a member of oneof_ _boot_file_ipv6_url.
creation_timestamp str
Output only. [Output Only] Creation timestamp inRFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
dns_search_paths MutableSequence[str]
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.
domain_name str
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. This field is a member of oneof_ _domain_name.
id int
Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier. This field is a member of oneof_ _id.
kind str
Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs. This field is a member of oneof_ _kind.
lease_time_sec int
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. This field is a member of oneof_ _lease_time_sec.
name str
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. This field is a member of oneof_ _name.
ntp_server_ipv4_addresses MutableSequence[str]
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.
ntp_server_ipv6_addresses MutableSequence[str]
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.
region str
Output only. [Output Only] URL of the region where the resource resides. This field is a member of oneof_ _region.
self_link str
Output only. [Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
tftp_server_ipv4_addresses MutableSequence[str]
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.
tftp_server_ipv4_name str
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. This field is a member of oneof_ _tftp_server_ipv4_name.

Classes

AssociationsEntry

AssociationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.