DesktopPool¶
- class oci.desktops.models.DesktopPool(**kwargs)¶
Bases:
objectProvides information about a desktop pool including all configuration parameters.
Attributes:
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the lifecycle_state property of a DesktopPool.
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool.
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool.
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool.
[Required] Gets the are_privileged_users of this DesktopPool.
[Required] Gets the availability_domain of this DesktopPool.
[Required] Gets the availability_policy of this DesktopPool.
Gets the boot_volume_size_in_gbs of this DesktopPool.
[Required] Gets the compartment_id of this DesktopPool.
[Required] Gets the contact_details of this DesktopPool.
Gets the defined_tags of this DesktopPool.
Gets the description of this DesktopPool.
[Required] Gets the device_policy of this DesktopPool.
[Required] Gets the display_name of this DesktopPool.
Gets the freeform_tags of this DesktopPool.
[Required] Gets the id of this DesktopPool.
[Required] Gets the image of this DesktopPool.
[Required] Gets the is_storage_enabled of this DesktopPool.
[Required] Gets the lifecycle_state of this DesktopPool.
[Required] Gets the maximum_size of this DesktopPool.
[Required] Gets the network_configuration of this DesktopPool.
Gets the nsg_ids of this DesktopPool.
Gets the private_access_details of this DesktopPool.
Gets the security_attributes of this DesktopPool.
Gets the session_lifecycle_actions of this DesktopPool.
Gets the shape_config of this DesktopPool.
[Required] Gets the shape_name of this DesktopPool.
[Required] Gets the standby_size of this DesktopPool.
[Required] Gets the storage_backup_policy_id of this DesktopPool.
[Required] Gets the storage_size_in_gbs of this DesktopPool.
[Required] Gets the time_created of this DesktopPool.
Gets the time_start_scheduled of this DesktopPool.
Gets the time_stop_scheduled of this DesktopPool.
Gets the use_dedicated_vm_host of this DesktopPool.
Methods:
__init__(**kwargs)Initializes a new DesktopPool object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DesktopPool. This constant has a value of “UPDATING”
- USE_DEDICATED_VM_HOST_AUTO = 'AUTO'¶
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool. This constant has a value of “AUTO”
- USE_DEDICATED_VM_HOST_FALSE = 'FALSE'¶
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool. This constant has a value of “FALSE”
- USE_DEDICATED_VM_HOST_TRUE = 'TRUE'¶
A constant which can be used with the use_dedicated_vm_host property of a DesktopPool. This constant has a value of “TRUE”
- __init__(**kwargs)¶
Initializes a new DesktopPool object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this DesktopPool.
compartment_id (str) – The value to assign to the compartment_id property of this DesktopPool.
display_name (str) – The value to assign to the display_name property of this DesktopPool.
description (str) – The value to assign to the description property of this DesktopPool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DesktopPool. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this DesktopPool.
maximum_size (int) – The value to assign to the maximum_size property of this DesktopPool.
standby_size (int) – The value to assign to the standby_size property of this DesktopPool.
shape_name (str) – The value to assign to the shape_name property of this DesktopPool.
shape_config (oci.desktops.models.DesktopPoolShapeConfig) – The value to assign to the shape_config property of this DesktopPool.
use_dedicated_vm_host (str) – The value to assign to the use_dedicated_vm_host property of this DesktopPool. Allowed values for this property are: “TRUE”, “FALSE”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_storage_enabled (bool) – The value to assign to the is_storage_enabled property of this DesktopPool.
storage_size_in_gbs (int) – The value to assign to the storage_size_in_gbs property of this DesktopPool.
storage_backup_policy_id (str) – The value to assign to the storage_backup_policy_id property of this DesktopPool.
device_policy (oci.desktops.models.DesktopDevicePolicy) – The value to assign to the device_policy property of this DesktopPool.
availability_policy (oci.desktops.models.DesktopAvailabilityPolicy) – The value to assign to the availability_policy property of this DesktopPool.
image (oci.desktops.models.DesktopImage) – The value to assign to the image property of this DesktopPool.
network_configuration (oci.desktops.models.DesktopNetworkConfiguration) – The value to assign to the network_configuration property of this DesktopPool.
session_lifecycle_actions (oci.desktops.models.DesktopSessionLifecycleActions) – The value to assign to the session_lifecycle_actions property of this DesktopPool.
time_start_scheduled (datetime) – The value to assign to the time_start_scheduled property of this DesktopPool.
time_stop_scheduled (datetime) – The value to assign to the time_stop_scheduled property of this DesktopPool.
contact_details (str) – The value to assign to the contact_details property of this DesktopPool.
are_privileged_users (bool) – The value to assign to the are_privileged_users property of this DesktopPool.
availability_domain (str) – The value to assign to the availability_domain property of this DesktopPool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DesktopPool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DesktopPool.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DesktopPool.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DesktopPool.
private_access_details (oci.desktops.models.DesktopPoolPrivateAccessDetails) – The value to assign to the private_access_details property of this DesktopPool.
boot_volume_size_in_gbs (int) – The value to assign to the boot_volume_size_in_gbs property of this DesktopPool.
- property are_privileged_users¶
[Required] Gets the are_privileged_users of this DesktopPool. Indicates whether desktop pool users have administrative privileges on their desktop.
- Returns
The are_privileged_users of this DesktopPool.
- Return type
bool
- property availability_domain¶
[Required] Gets the availability_domain of this DesktopPool. The availability domain of the desktop pool.
- Returns
The availability_domain of this DesktopPool.
- Return type
str
- property availability_policy¶
[Required] Gets the availability_policy of this DesktopPool.
- Returns
The availability_policy of this DesktopPool.
- Return type
- property boot_volume_size_in_gbs¶
Gets the boot_volume_size_in_gbs of this DesktopPool. The size in GBs of the boot volume for the desktop pool.
- Returns
The boot_volume_size_in_gbs of this DesktopPool.
- Return type
int
- property compartment_id¶
[Required] Gets the compartment_id of this DesktopPool. The OCID of the compartment of the desktop pool.
- Returns
The compartment_id of this DesktopPool.
- Return type
str
- property contact_details¶
[Required] Gets the contact_details of this DesktopPool. Contact information of the desktop pool administrator. Avoid entering confidential information.
- Returns
The contact_details of this DesktopPool.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DesktopPool. 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 DesktopPool.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DesktopPool. A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Returns
The description of this DesktopPool.
- Return type
str
- property device_policy¶
[Required] Gets the device_policy of this DesktopPool.
- Returns
The device_policy of this DesktopPool.
- Return type
- property display_name¶
[Required] Gets the display_name of this DesktopPool. A user friendly display name. Avoid entering confidential information.
- Returns
The display_name of this DesktopPool.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DesktopPool. 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 DesktopPool.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DesktopPool. The OCID of the desktop pool.
- Returns
The id of this DesktopPool.
- Return type
str
- property image¶
[Required] Gets the image of this DesktopPool.
- Returns
The image of this DesktopPool.
- Return type
- property is_storage_enabled¶
[Required] Gets the is_storage_enabled of this DesktopPool. Indicates whether storage is enabled for the desktop pool.
- Returns
The is_storage_enabled of this DesktopPool.
- Return type
bool
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DesktopPool. The current state of the desktop pool.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DesktopPool.
- Return type
str
- property maximum_size¶
[Required] Gets the maximum_size of this DesktopPool. The maximum number of desktops permitted in the desktop pool.
- Returns
The maximum_size of this DesktopPool.
- Return type
int
- property network_configuration¶
[Required] Gets the network_configuration of this DesktopPool.
- Returns
The network_configuration of this DesktopPool.
- Return type
- property nsg_ids¶
Gets the nsg_ids of this DesktopPool. A list of network security groups for the network.
- Returns
The nsg_ids of this DesktopPool.
- Return type
list[str]
- property private_access_details¶
Gets the private_access_details of this DesktopPool.
- Returns
The private_access_details of this DesktopPool.
- Return type
- property security_attributes¶
Gets the security_attributes of this DesktopPool. Security attributes for this resource. Each attribute can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.
Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}
- Returns
The security_attributes of this DesktopPool.
- Return type
dict(str, dict(str, object))
- property session_lifecycle_actions¶
Gets the session_lifecycle_actions of this DesktopPool.
- Returns
The session_lifecycle_actions of this DesktopPool.
- Return type
- property shape_config¶
Gets the shape_config of this DesktopPool.
- Returns
The shape_config of this DesktopPool.
- Return type
- property shape_name¶
[Required] Gets the shape_name of this DesktopPool. The shape of the desktop pool.
- Returns
The shape_name of this DesktopPool.
- Return type
str
- property standby_size¶
[Required] Gets the standby_size of this DesktopPool. The maximum number of standby desktops available in the desktop pool.
- Returns
The standby_size of this DesktopPool.
- Return type
int
- property storage_backup_policy_id¶
[Required] Gets the storage_backup_policy_id of this DesktopPool. The backup policy OCID of the storage.
- Returns
The storage_backup_policy_id of this DesktopPool.
- Return type
str
- property storage_size_in_gbs¶
[Required] Gets the storage_size_in_gbs of this DesktopPool. The size in GBs of the storage for the desktop pool.
- Returns
The storage_size_in_gbs of this DesktopPool.
- Return type
int
- property time_created¶
[Required] Gets the time_created of this DesktopPool. The date and time the resource was created.
- Returns
The time_created of this DesktopPool.
- Return type
datetime
- property time_start_scheduled¶
Gets the time_start_scheduled of this DesktopPool. The start time of the desktop pool.
- Returns
The time_start_scheduled of this DesktopPool.
- Return type
datetime
- property time_stop_scheduled¶
Gets the time_stop_scheduled of this DesktopPool. The stop time of the desktop pool.
- Returns
The time_stop_scheduled of this DesktopPool.
- Return type
datetime
- property use_dedicated_vm_host¶
Gets the use_dedicated_vm_host of this DesktopPool. Indicates whether the desktop pool uses dedicated virtual machine hosts.
Allowed values for this property are: “TRUE”, “FALSE”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The use_dedicated_vm_host of this DesktopPool.
- Return type
str