REST API for Oracle Private Cloud Appliance Compute Enclave

UpdateDhcpOptions

put

/20160918/dhcps/{dhcp_id}

Update the specified set of DHCP options. You can update the display name or the options themselves. Avoid entering confidential information.

Note: The options object you provide replaces the entire existing set of options.

Request

Supported Media Types

application/json

Path Parameters

dhcpId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID for the set of DHCP options.

Header Parameters

if-match: string

For 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.

Request object for updating a set of DHCP options.

Root Schema : UpdateDhcpDetails

Type: object

Show Source

definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
domainNameType: string

Allowed Values: [ "SUBNET_DOMAIN", "VCN_DOMAIN", "CUSTOM_DOMAIN" ]

The search domain name type of DHCP options
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
options: array options

Unique Items Required: true

{
    "properties":{
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "options":{
            "items":{
                "$ref":"#/definitions/DhcpOption"
            },
            "type":"array",
            "uniqueItems":true
        },
        "domainNameType":{
            "description":"The search domain name type of DHCP options",
            "enum":[
                "SUBNET_DOMAIN",
                "VCN_DOMAIN",
                "CUSTOM_DOMAIN"
            ],
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : options

Type: array

Unique Items Required: true

Show Source

Array of: object DhcpOption

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

{
    "items":{
        "$ref":"#/definitions/DhcpOption"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : DhcpOption

Type: object

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

Show Source

type(required): string

The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

{
    "description":"A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).",
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

The set of DHCP options was updated.

Headers

etag: string

For optimistic concurrency control. See if-match.
opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : DhcpOptions

Type: 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 handled in the subnets in your VCN. DhcpSearchDomainOption - Lets you specify a search domain name to use for DNS queries.

Show Source

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment containing the set of DHCP options.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
domainNameType: string

Allowed Values: [ "SUBNET_DOMAIN", "VCN_DOMAIN", "CUSTOM_DOMAIN" ]

The search domain name type of DHCP options
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
id(required): string

Minimum Length: 1

Maximum Length: 255

OCID for the set of DHCP options.
lifecycleState(required): string

Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

The current state of the set of DHCP options.
options(required): array options

The collection of individual DHCP options.
timeCreated(required): string(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
vcnId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the VCN the set of DHCP options belongs to.

{
    "description":"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 handled in the subnets in your VCN. DhcpSearchDomainOption - Lets you specify a search domain name to use for DNS queries.",
    "x-obmcs-splat":{
        "resourceKind":"dhcp-option",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the set of DHCP options.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "description":"OCID for the set of DHCP options.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the set of DHCP options.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "options":{
            "description":"The collection of individual DHCP options.",
            "items":{
                "$ref":"#/definitions/DhcpOption"
            },
            "type":"array"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the VCN the set of DHCP options belongs to.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "domainNameType":{
            "description":"The search domain name type of DHCP options",
            "enum":[
                "SUBNET_DOMAIN",
                "VCN_DOMAIN",
                "CUSTOM_DOMAIN"
            ],
            "type":"string"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "options",
        "lifecycleState",
        "timeCreated",
        "vcnId"
    ],
    "x-example":"{   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"MyDhcpOptions\",   \"id\": \"ocid1.dhcpoptions.<var>unique_ID</var>\",   \"lifecycleState\": \"AVAILABLE\",   \"options\": [{     \"type\": \"DomainNameServer\",     \"customDnsServers\": [\"203.0.113.7\"],     \"serverType\": \"CustomDnsServer\"   }],   \"timeCreated\": \"2016-12-17T01:31:50.047Z\",   \"vcnId\": \"ocid1.vcn.<var>unique_ID</var>\" } ",
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : options

Type: array

The collection of individual DHCP options.

Show Source

Array of: object DhcpOption

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

{
    "description":"The collection of individual DHCP options.",
    "items":{
        "$ref":"#/definitions/DhcpOption"
    },
    "type":"array"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : DhcpOption

Type: object

Discriminator: type

A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.

Show Source

type(required): string

The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

{
    "description":"A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).",
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

412 Response

Precondition Failed

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing..

Example: UnknownError
message(required): string

A human-readable error string.

Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}