Skip to main content

dhcp_options

Creates, updates, deletes, gets or lists a dhcp_options resource.

Overview​

Namedhcp_options
TypeResource
Idoci.network.dhcp_options

Fields​

The following fields are returned by SELECT queries:

The set of DHCP options was retrieved.

NameDatatypeDescription
idstringOracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the set of DHCP options.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleStatestringThe current state of the set of DHCP options. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
optionsarrayThe collection of individual DHCP options.
timeCreatedstring (date-time)Date and time the set of DHCP options was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdhcpId, regionGets the specified set of DHCP options.
listselectcompartmentId, regionvcnId, limit, page, displayName, sortBy, sortOrder, lifecycleStateLists the sets of DHCP options in the specified VCN and specified compartment.<br />If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment.<br />The response includes the default set of options that automatically comes with each VCN,<br />plus any other sets you've created.<br />
createinsertregion, compartmentId, options, vcnIdopc-retry-tokenCreates a new set of DHCP options for the specified VCN. For more information, see<br />[DhcpOptions](#/en/iaas/latest/DhcpOptions/).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of<br />DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,<br />subnets, or other Networking Service components. If you're not sure which compartment to use, put the set<br />of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the set of DHCP options, otherwise a default is provided.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />
updateupdatedhcpId, regionif-matchUpdates the specified set of DHCP options. You can update the display name or the options<br />themselves. Avoid entering confidential information.<br /><br />Note that the options object you provide replaces the entire existing set of options.<br />
deletedeletedhcpId, regionif-matchDeletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a<br />VCN's default set of DHCP options.<br /><br />This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily<br />until the set is completely removed.<br />
change_compartmentexecdhcpId, region, compartmentIdopc-request-id, opc-retry-tokenMoves a set of DHCP options into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
dhcpIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleStatestringA filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.

SELECT examples​

Gets the specified set of DHCP options.

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
options,
timeCreated,
vcnId
FROM oci.network.dhcp_options
WHERE dhcpId = '{{ dhcpId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a new set of DHCP options for the specified VCN. For more information, see<br />[DhcpOptions](#/en/iaas/latest/DhcpOptions/).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of<br />DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,<br />subnets, or other Networking Service components. If you're not sure which compartment to use, put the set<br />of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the set of DHCP options, otherwise a default is provided.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />

INSERT INTO oci.network.dhcp_options (
compartmentId,
definedTags,
displayName,
freeformTags,
options,
vcnId,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ options }}' /* required */,
'{{ vcnId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
options,
timeCreated,
vcnId
;

UPDATE examples​

Updates the specified set of DHCP options. You can update the display name or the options<br />themselves. Avoid entering confidential information.<br /><br />Note that the options object you provide replaces the entire existing set of options.<br />

UPDATE oci.network.dhcp_options
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
options = '{{ options }}'
WHERE 
dhcpId = '{{ dhcpId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
options,
timeCreated,
vcnId;

DELETE examples​

Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a<br />VCN's default set of DHCP options.<br /><br />This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily<br />until the set is completely removed.<br />

DELETE FROM oci.network.dhcp_options
WHERE dhcpId = '{{ dhcpId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a set of DHCP options into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.network.dhcp_options.change_compartment 
@dhcpId='{{ dhcpId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;