Byol¶
- class oci.ocvp.models.Byol(**kwargs)¶
Bases:
objectAn `Oracle Cloud VMware Solution`__ Bring-Your-Own-License (BYOL), is a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.
Attributes:
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the lifecycle_state property of a Byol.
A constant which can be used with the software_type property of a Byol.
A constant which can be used with the software_type property of a Byol.
A constant which can be used with the software_type property of a Byol.
A constant which can be used with the software_type property of a Byol.
[Required] Gets the available_units of this Byol.
[Required] Gets the compartment_id of this Byol.
[Required] Gets the defined_tags of this Byol.
Gets the description of this Byol.
[Required] Gets the display_name of this Byol.
[Required] Gets the entitlement_key of this Byol.
[Required] Gets the freeform_tags of this Byol.
[Required] Gets the id of this Byol.
[Required] Gets the lifecycle_state of this Byol.
Gets the site_id of this Byol.
[Required] Gets the software_type of this Byol.
[Required] Gets the system_tags of this Byol.
[Required] Gets the time_created of this Byol.
[Required] Gets the time_term_end of this Byol.
[Required] Gets the time_term_start of this Byol.
[Required] Gets the time_updated of this Byol.
[Required] Gets the total_units of this Byol.
Methods:
__init__(**kwargs)Initializes a new Byol object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Byol. This constant has a value of “UPDATING”
- SOFTWARE_TYPE_AVI_LOAD_BALANCER = 'AVI_LOAD_BALANCER'¶
A constant which can be used with the software_type property of a Byol. This constant has a value of “AVI_LOAD_BALANCER”
- SOFTWARE_TYPE_VCF = 'VCF'¶
A constant which can be used with the software_type property of a Byol. This constant has a value of “VCF”
- SOFTWARE_TYPE_VDEFEND = 'VDEFEND'¶
A constant which can be used with the software_type property of a Byol. This constant has a value of “VDEFEND”
- SOFTWARE_TYPE_VSAN = 'VSAN'¶
A constant which can be used with the software_type property of a Byol. This constant has a value of “VSAN”
- __init__(**kwargs)¶
Initializes a new Byol 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 Byol.
compartment_id (str) – The value to assign to the compartment_id property of this Byol.
display_name (str) – The value to assign to the display_name property of this Byol.
description (str) – The value to assign to the description property of this Byol.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Byol. 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’.
software_type (str) – The value to assign to the software_type property of this Byol. Allowed values for this property are: “VCF”, “VSAN”, “VDEFEND”, “AVI_LOAD_BALANCER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
total_units (int) – The value to assign to the total_units property of this Byol.
available_units (int) – The value to assign to the available_units property of this Byol.
time_term_start (datetime) – The value to assign to the time_term_start property of this Byol.
time_term_end (datetime) – The value to assign to the time_term_end property of this Byol.
entitlement_key (str) – The value to assign to the entitlement_key property of this Byol.
site_id (str) – The value to assign to the site_id property of this Byol.
time_created (datetime) – The value to assign to the time_created property of this Byol.
time_updated (datetime) – The value to assign to the time_updated property of this Byol.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Byol.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Byol.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Byol.
- property available_units¶
[Required] Gets the available_units of this Byol. The quantity of licensed units that not yet allocated to specific region.
- Returns
The available_units of this Byol.
- Return type
int
- property compartment_id¶
[Required] Gets the compartment_id of this Byol. The `OCID`__ of the compartment that contains the BYOL.
- Returns
The compartment_id of this Byol.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this Byol. 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 Byol.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Byol. A description of the BYOL.
- Returns
The description of this Byol.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Byol. A descriptive name for the BYOL.
- Returns
The display_name of this Byol.
- Return type
str
- property entitlement_key¶
[Required] Gets the entitlement_key of this Byol. The Broadcom-supplied identifier of a BYOL license.
- Returns
The entitlement_key of this Byol.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this Byol. 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 Byol.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Byol. The `OCID`__ of the BYOL.
- Returns
The id of this Byol.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Byol. The current state of the BYOL.
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 Byol.
- Return type
str
- property site_id¶
Gets the site_id of this Byol. The hyperscaler identifier in Broadcom systems.
- Returns
The site_id of this Byol.
- Return type
str
- property software_type¶
[Required] Gets the software_type of this Byol. The type of VMware software the BYOL applies to. Supported values: - VCF (VMware Cloud Foundation) - VSAN (VMware vSAN) - VDEFEND (VMware vDefend Firewall) - AVI_LOAD_BALANCER (VMware Avi Load Balancer)
Allowed values for this property are: “VCF”, “VSAN”, “VDEFEND”, “AVI_LOAD_BALANCER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The software_type of this Byol.
- Return type
str
- property system_tags¶
[Required] Gets the system_tags of this Byol. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
- Returns
The system_tags of this Byol.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this Byol. The date and time the BYOL was created, in the format defined by `RFC3339`__. Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this Byol.
- Return type
datetime
- property time_term_end¶
[Required] Gets the time_term_end of this Byol. The date and time when the BYOL expires and becomes inactive. In the format defined by`RFC3339`__.
- Returns
The time_term_end of this Byol.
- Return type
datetime
- property time_term_start¶
[Required] Gets the time_term_start of this Byol. The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time. In the format defined by`RFC3339`__. Example: 2016-08-25T21:10:29.600Z
- Returns
The time_term_start of this Byol.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this Byol. The date and time the BYOL was updated, in the format defined by `RFC3339`__.
- Returns
The time_updated of this Byol.
- Return type
datetime
- property total_units¶
[Required] Gets the total_units of this Byol. Total quantity of licensed units for the specified softwareType:
VCF, VDEFEND: number of OCPUs
VSAN: storage capacity in TiB (tebibytes)
AVI_LOAD_BALANCER: number of instances
- Returns
The total_units of this Byol.
- Return type
int