DhcpOptions

class oci.core.models.DhcpOptions(**kwargs)

Bases: object

A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set:

  • DhcpDnsOption: Lets you specify how DNS (hostname resolution) is

Attributes

DOMAIN_NAME_TYPE_CUSTOM_DOMAIN A constant which can be used with the domain_name_type property of a DhcpOptions.
DOMAIN_NAME_TYPE_SUBNET_DOMAIN A constant which can be used with the domain_name_type property of a DhcpOptions.
DOMAIN_NAME_TYPE_VCN_DOMAIN A constant which can be used with the domain_name_type property of a DhcpOptions.
LIFECYCLE_STATE_AVAILABLE A constant which can be used with the lifecycle_state property of a DhcpOptions.
LIFECYCLE_STATE_PROVISIONING A constant which can be used with the lifecycle_state property of a DhcpOptions.
LIFECYCLE_STATE_TERMINATED A constant which can be used with the lifecycle_state property of a DhcpOptions.
LIFECYCLE_STATE_TERMINATING A constant which can be used with the lifecycle_state property of a DhcpOptions.
compartment_id [Required] Gets the compartment_id of this DhcpOptions.
defined_tags Gets the defined_tags of this DhcpOptions.
display_name Gets the display_name of this DhcpOptions.
domain_name_type Gets the domain_name_type of this DhcpOptions.
freeform_tags Gets the freeform_tags of this DhcpOptions.
id [Required] Gets the id of this DhcpOptions.
lifecycle_state [Required] Gets the lifecycle_state of this DhcpOptions.
options [Required] Gets the options of this DhcpOptions.
time_created [Required] Gets the time_created of this DhcpOptions.
vcn_id [Required] Gets the vcn_id of this DhcpOptions.

Methods

__init__(**kwargs) Initializes a new DhcpOptions object with values from keyword arguments.

handled in the subnets in your VCN.

a search domain name to use for DNS queries.

For more information, see DNS in Your Virtual Cloud Network and DHCP Options.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

DOMAIN_NAME_TYPE_CUSTOM_DOMAIN = 'CUSTOM_DOMAIN'

A constant which can be used with the domain_name_type property of a DhcpOptions. This constant has a value of “CUSTOM_DOMAIN”

DOMAIN_NAME_TYPE_SUBNET_DOMAIN = 'SUBNET_DOMAIN'

A constant which can be used with the domain_name_type property of a DhcpOptions. This constant has a value of “SUBNET_DOMAIN”

DOMAIN_NAME_TYPE_VCN_DOMAIN = 'VCN_DOMAIN'

A constant which can be used with the domain_name_type property of a DhcpOptions. This constant has a value of “VCN_DOMAIN”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a DhcpOptions. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a DhcpOptions. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a DhcpOptions. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a DhcpOptions. This constant has a value of “TERMINATING”

__init__(**kwargs)

Initializes a new DhcpOptions object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • compartment_id (str) – The value to assign to the compartment_id property of this DhcpOptions.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DhcpOptions.
  • display_name (str) – The value to assign to the display_name property of this DhcpOptions.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DhcpOptions.
  • id (str) – The value to assign to the id property of this DhcpOptions.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DhcpOptions. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • options (list[oci.core.models.DhcpOption]) – The value to assign to the options property of this DhcpOptions.
  • time_created (datetime) – The value to assign to the time_created property of this DhcpOptions.
  • vcn_id (str) – The value to assign to the vcn_id property of this DhcpOptions.
  • domain_name_type (str) – The value to assign to the domain_name_type property of this DhcpOptions. Allowed values for this property are: “SUBNET_DOMAIN”, “VCN_DOMAIN”, “CUSTOM_DOMAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id

[Required] Gets the compartment_id of this DhcpOptions. The OCID of the compartment containing the set of DHCP options.

Returns:The compartment_id of this DhcpOptions.
Return type:str
defined_tags

Gets the defined_tags of this DhcpOptions. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:The defined_tags of this DhcpOptions.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this DhcpOptions. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this DhcpOptions.
Return type:str
domain_name_type

Gets the domain_name_type of this DhcpOptions. The search domain name type of DHCP options

Allowed values for this property are: “SUBNET_DOMAIN”, “VCN_DOMAIN”, “CUSTOM_DOMAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The domain_name_type of this DhcpOptions.
Return type:str
freeform_tags

Gets the freeform_tags of this DhcpOptions. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:The freeform_tags of this DhcpOptions.
Return type:dict(str, str)
id

[Required] Gets the id of this DhcpOptions. Oracle ID (OCID) for the set of DHCP options.

Returns:The id of this DhcpOptions.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this DhcpOptions. The current state of the set of DHCP options.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this DhcpOptions.
Return type:str
options

[Required] Gets the options of this DhcpOptions. The collection of individual DHCP options.

Returns:The options of this DhcpOptions.
Return type:list[oci.core.models.DhcpOption]
time_created

[Required] Gets the time_created of this DhcpOptions. Date and time the set of DHCP options was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this DhcpOptions.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this DhcpOptions. The OCID of the VCN the set of DHCP options belongs to.

Returns:The vcn_id of this DhcpOptions.
Return type:str