APIVersion: desktops.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
No customer-visible package currently exposes desktops.oracle.com/v1beta1.
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| DesktopPool | Namespaced | Sample | - |
DesktopPool is the Schema for the desktoppools API.
Plural: desktoppoolsScope: NamespacedAPIVersion: desktops.oracle.com/v1beta1Sample: Sample (config/samples/desktops_v1beta1_desktoppool.yaml)Packages: Not currently exposed by a customer-visible package.DesktopPoolSpec defines the desired state of DesktopPool.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
arePrivilegedUsers |
Indicates whether desktop pool users have administrative privileges on their desktop. | boolean |
Yes | - | - |
availabilityDomain |
The availability domain of the desktop pool. | string |
Yes | - | - |
availabilityPolicy |
DesktopPoolAvailabilityPolicy defines nested fields for DesktopPool.AvailabilityPolicy. | object |
Yes | - | - |
bootVolumeSizeInGBs |
The size in GBs of the boot volume for the desktop pool. | integer |
No | - | - |
compartmentId |
The OCID of the compartment which will contain the desktop pool. | string |
Yes | - | - |
contactDetails |
Contact information of the desktop pool administrator. Avoid entering confidential information. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A user friendly description providing additional information about the resource. Avoid entering confidential information. | string |
No | - | - |
devicePolicy |
DesktopPoolDevicePolicy defines nested fields for DesktopPool.DevicePolicy. | object |
Yes | - | - |
displayName |
A user friendly display name. Avoid entering confidential information. | string |
Yes | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
image |
DesktopPoolImage defines nested fields for DesktopPool.Image. | object |
Yes | - | - |
isStorageEnabled |
Indicates whether storage is enabled for the desktop pool. | boolean |
Yes | - | - |
maximumSize |
The maximum number of desktops permitted in the desktop pool. | integer |
Yes | - | - |
networkConfiguration |
DesktopPoolNetworkConfiguration defines nested fields for DesktopPool.NetworkConfiguration. | object |
Yes | - | - |
nsgIds |
A list of network security groups for the private access. | list[string] |
No | - | - |
privateAccessDetails |
DesktopPoolPrivateAccessDetails defines nested fields for DesktopPool.PrivateAccessDetails. | object |
No | - | - |
sessionLifecycleActions |
DesktopPoolSessionLifecycleActions defines nested fields for DesktopPool.SessionLifecycleActions. | object |
No | - | - |
shapeConfig |
DesktopPoolShapeConfig defines nested fields for DesktopPool.ShapeConfig. | object |
No | - | - |
shapeName |
The shape of the desktop pool. | string |
Yes | - | - |
standbySize |
The maximum number of standby desktops available in the desktop pool. | integer |
Yes | - | - |
storageBackupPolicyId |
The backup policy OCID of the storage. | string |
Yes | - | - |
storageSizeInGBs |
The size in GBs of the storage for the desktop pool. | integer |
Yes | - | - |
timeStartScheduled |
The start time of the desktop pool. | string |
No | - | - |
timeStopScheduled |
The stop time of the desktop pool. | string |
No | - | - |
useDedicatedVmHost |
Indicates whether the desktop pool uses dedicated virtual machine hosts. | string |
No | - | - |
DesktopPoolAvailabilityPolicy defines nested fields for DesktopPool.AvailabilityPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
startSchedule |
DesktopPoolAvailabilityPolicyStartSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StartSchedule. | object |
Yes | - | - |
stopSchedule |
DesktopPoolAvailabilityPolicyStopSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StopSchedule. | object |
Yes | - | - |
DesktopPoolAvailabilityPolicyStartSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StartSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cronExpression |
A cron expression describing the desktop’s schedule. | string |
Yes | - | - |
timezone |
The timezone of the desktop’s schedule. | string |
Yes | - | - |
DesktopPoolAvailabilityPolicyStopSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StopSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cronExpression |
A cron expression describing the desktop’s schedule. | string |
Yes | - | - |
timezone |
The timezone of the desktop’s schedule. | string |
Yes | - | - |
DesktopPoolDevicePolicy defines nested fields for DesktopPool.DevicePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audioMode |
The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. | string |
Yes | - | - |
cdmMode |
The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. | string |
Yes | - | - |
clipboardMode |
The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. | string |
Yes | - | - |
isDisplayEnabled |
Indicates whether the display is enabled. | boolean |
Yes | - | - |
isKeyboardEnabled |
Indicates whether the keyboard is enabled. | boolean |
Yes | - | - |
isPointerEnabled |
Indicates whether the pointer is enabled. | boolean |
Yes | - | - |
isPrintingEnabled |
Indicates whether printing is enabled. | boolean |
Yes | - | - |
isVideoInputEnabled |
Indicates whether video input is enabled. | boolean |
No | - | - |
DesktopPoolImage defines nested fields for DesktopPool.Image.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
imageId |
The OCID of the desktop image. | string |
Yes | - | - |
imageName |
The name of the desktop image. | string |
Yes | - | - |
operatingSystem |
The operating system of the desktop image, e.g. “Oracle Linux”, “Windows”. | string |
No | - | - |
DesktopPoolNetworkConfiguration defines nested fields for DesktopPool.NetworkConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. | string |
Yes | - | - |
vcnId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. | string |
Yes | - | - |
DesktopPoolPrivateAccessDetails defines nested fields for DesktopPool.PrivateAccessDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
nsgIds |
A list of network security groups for the private access. | list[string] |
No | - | - |
privateIp |
The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet. | string |
No | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. | string |
Yes | - | - |
DesktopPoolSessionLifecycleActions defines nested fields for DesktopPool.SessionLifecycleActions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
disconnect |
DesktopPoolSessionLifecycleActionsDisconnect defines nested fields for DesktopPool.SessionLifecycleActions.Disconnect. | object |
No | - | - |
inactivity |
DesktopPoolSessionLifecycleActionsInactivity defines nested fields for DesktopPool.SessionLifecycleActions.Inactivity. | object |
No | - | - |
DesktopPoolSessionLifecycleActionsDisconnect defines nested fields for DesktopPool.SessionLifecycleActions.Disconnect.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
a disconnect action to be triggered | string |
Yes | - | - |
gracePeriodInMinutes |
The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used. | integer |
No | - | - |
DesktopPoolSessionLifecycleActionsInactivity defines nested fields for DesktopPool.SessionLifecycleActions.Inactivity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
an inactivity action to be triggered | string |
Yes | - | - |
gracePeriodInMinutes |
The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. | integer |
No | - | - |
DesktopPoolShapeConfig defines nested fields for DesktopPool.ShapeConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
baselineOcpuUtilization |
The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1. The following values are supported: - BASELINE_1_8 - baseline usage is 1/8 of an OCPU. - BASELINE_1_2 - baseline usage is 1/2 of an OCPU. - BASELINE_1_1 - baseline usage is the entire OCPU. This represents a non-burstable instance. |
string |
No | - | - |
memoryInGBs |
The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool. | integer (int64) |
No | - | - |
ocpus |
The total number of OCPUs available for each desktop compute instance in the desktop pool. | integer (int64) |
No | - | - |
DesktopPoolStatus defines the observed state of DesktopPool.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
activeDesktops |
The number of active desktops in the desktop pool. | integer |
No | - | - |
arePrivilegedUsers |
Indicates whether desktop pool users have administrative privileges on their desktop. | boolean |
No | - | - |
availabilityDomain |
The availability domain of the desktop pool. | string |
No | - | - |
availabilityPolicy |
DesktopPoolAvailabilityPolicy defines nested fields for DesktopPool.AvailabilityPolicy. | object |
No | - | - |
bootVolumeSizeInGBs |
The size in GBs of the boot volume for the desktop pool. | integer |
No | - | - |
compartmentId |
The OCID of the compartment of the desktop pool. | string |
No | - | - |
contactDetails |
Contact information of the desktop pool administrator. Avoid entering confidential information. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A user friendly description providing additional information about the resource. Avoid entering confidential information. | string |
No | - | - |
devicePolicy |
DesktopPoolDevicePolicy defines nested fields for DesktopPool.DevicePolicy. | object |
No | - | - |
displayName |
A user friendly display name. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID of the desktop pool. | string |
No | - | - |
image |
DesktopPoolImage defines nested fields for DesktopPool.Image. | object |
No | - | - |
isStorageEnabled |
Indicates whether storage is enabled for the desktop pool. | boolean |
No | - | - |
lifecycleState |
The current state of the desktop pool. | string |
No | - | - |
maximumSize |
The maximum number of desktops permitted in the desktop pool. | integer |
No | - | - |
networkConfiguration |
DesktopPoolNetworkConfiguration defines nested fields for DesktopPool.NetworkConfiguration. | object |
No | - | - |
nsgIds |
A list of network security groups for the network. | list[string] |
No | - | - |
privateAccessDetails |
DesktopPoolPrivateAccessDetails defines nested fields for DesktopPool.PrivateAccessDetails. | object |
No | - | - |
sessionLifecycleActions |
DesktopPoolSessionLifecycleActions defines nested fields for DesktopPool.SessionLifecycleActions. | object |
No | - | - |
shapeConfig |
DesktopPoolShapeConfig defines nested fields for DesktopPool.ShapeConfig. | object |
No | - | - |
shapeName |
The shape of the desktop pool. | string |
No | - | - |
standbySize |
The maximum number of standby desktops available in the desktop pool. | integer |
No | - | - |
status |
- | object |
Yes | - | - |
storageBackupPolicyId |
The backup policy OCID of the storage. | string |
No | - | - |
storageSizeInGBs |
The size in GBs of the storage for the desktop pool. | integer |
No | - | - |
timeCreated |
The date and time the resource was created. | string |
No | - | - |
timeStartScheduled |
The start time of the desktop pool. | string |
No | - | - |
timeStopScheduled |
The stop time of the desktop pool. | string |
No | - | - |
useDedicatedVmHost |
Indicates whether the desktop pool uses dedicated virtual machine hosts. | string |
No | - | - |
DesktopPoolAvailabilityPolicy defines nested fields for DesktopPool.AvailabilityPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
startSchedule |
DesktopPoolAvailabilityPolicyStartSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StartSchedule. | object |
Yes | - | - |
stopSchedule |
DesktopPoolAvailabilityPolicyStopSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StopSchedule. | object |
Yes | - | - |
DesktopPoolAvailabilityPolicyStartSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StartSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cronExpression |
A cron expression describing the desktop’s schedule. | string |
Yes | - | - |
timezone |
The timezone of the desktop’s schedule. | string |
Yes | - | - |
DesktopPoolAvailabilityPolicyStopSchedule defines nested fields for DesktopPool.AvailabilityPolicy.StopSchedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cronExpression |
A cron expression describing the desktop’s schedule. | string |
Yes | - | - |
timezone |
The timezone of the desktop’s schedule. | string |
Yes | - | - |
DesktopPoolDevicePolicy defines nested fields for DesktopPool.DevicePolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
audioMode |
The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. | string |
Yes | - | - |
cdmMode |
The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. | string |
Yes | - | - |
clipboardMode |
The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. | string |
Yes | - | - |
isDisplayEnabled |
Indicates whether the display is enabled. | boolean |
Yes | - | - |
isKeyboardEnabled |
Indicates whether the keyboard is enabled. | boolean |
Yes | - | - |
isPointerEnabled |
Indicates whether the pointer is enabled. | boolean |
Yes | - | - |
isPrintingEnabled |
Indicates whether printing is enabled. | boolean |
Yes | - | - |
isVideoInputEnabled |
Indicates whether video input is enabled. | boolean |
No | - | - |
DesktopPoolImage defines nested fields for DesktopPool.Image.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
imageId |
The OCID of the desktop image. | string |
Yes | - | - |
imageName |
The name of the desktop image. | string |
Yes | - | - |
operatingSystem |
The operating system of the desktop image, e.g. “Oracle Linux”, “Windows”. | string |
No | - | - |
DesktopPoolNetworkConfiguration defines nested fields for DesktopPool.NetworkConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. | string |
Yes | - | - |
vcnId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. | string |
Yes | - | - |
DesktopPoolPrivateAccessDetails defines nested fields for DesktopPool.PrivateAccessDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
nsgIds |
A list of network security groups for the private access. | list[string] |
No | - | - |
privateIp |
The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet. | string |
No | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. | string |
Yes | - | - |
DesktopPoolSessionLifecycleActions defines nested fields for DesktopPool.SessionLifecycleActions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
disconnect |
DesktopPoolSessionLifecycleActionsDisconnect defines nested fields for DesktopPool.SessionLifecycleActions.Disconnect. | object |
No | - | - |
inactivity |
DesktopPoolSessionLifecycleActionsInactivity defines nested fields for DesktopPool.SessionLifecycleActions.Inactivity. | object |
No | - | - |
DesktopPoolSessionLifecycleActionsDisconnect defines nested fields for DesktopPool.SessionLifecycleActions.Disconnect.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
a disconnect action to be triggered | string |
Yes | - | - |
gracePeriodInMinutes |
The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used. | integer |
No | - | - |
DesktopPoolSessionLifecycleActionsInactivity defines nested fields for DesktopPool.SessionLifecycleActions.Inactivity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
an inactivity action to be triggered | string |
Yes | - | - |
gracePeriodInMinutes |
The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. | integer |
No | - | - |
DesktopPoolShapeConfig defines nested fields for DesktopPool.ShapeConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
baselineOcpuUtilization |
The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1. The following values are supported: - BASELINE_1_8 - baseline usage is 1/8 of an OCPU. - BASELINE_1_2 - baseline usage is 1/2 of an OCPU. - BASELINE_1_1 - baseline usage is the entire OCPU. This represents a non-burstable instance. |
string |
No | - | - |
memoryInGBs |
The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool. | integer (int64) |
No | - | - |
ocpus |
The total number of OCPUs available for each desktop compute instance in the desktop pool. | integer (int64) |
No | - | - |
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |