SddcSummary¶
- class oci.ocvp.models.SddcSummary(**kwargs)¶
Bases:
objectA summary of the SDDC.
Attributes:
A constant which can be used with the hcx_mode property of a SddcSummary.
A constant which can be used with the hcx_mode property of a SddcSummary.
A constant which can be used with the hcx_mode property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
A constant which can be used with the lifecycle_state property of a SddcSummary.
[Required] Gets the clusters_count of this SddcSummary.
[Required] Gets the compartment_id of this SddcSummary.
[Required] Gets the defined_tags of this SddcSummary.
[Required] Gets the display_name of this SddcSummary.
[Required] Gets the freeform_tags of this SddcSummary.
Gets the hcx_fqdn of this SddcSummary.
Gets the hcx_mode of this SddcSummary.
[Required] Gets the id of this SddcSummary.
Gets the is_single_host_sddc of this SddcSummary.
Gets the lifecycle_state of this SddcSummary.
Gets the nsx_manager_fqdn of this SddcSummary.
Gets the sddc_byol_allocation_details of this SddcSummary.
Gets the system_tags of this SddcSummary.
Gets the time_created of this SddcSummary.
Gets the time_updated of this SddcSummary.
Gets the vcenter_fqdn of this SddcSummary.
[Required] Gets the vmware_software_version of this SddcSummary.
Methods:
__init__(**kwargs)Initializes a new SddcSummary object with values from keyword arguments.
- HCX_MODE_ADVANCED = 'ADVANCED'¶
A constant which can be used with the hcx_mode property of a SddcSummary. This constant has a value of “ADVANCED”
- HCX_MODE_DISABLED = 'DISABLED'¶
A constant which can be used with the hcx_mode property of a SddcSummary. This constant has a value of “DISABLED”
- HCX_MODE_ENTERPRISE = 'ENTERPRISE'¶
A constant which can be used with the hcx_mode property of a SddcSummary. This constant has a value of “ENTERPRISE”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a SddcSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new SddcSummary 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 SddcSummary.
display_name (str) – The value to assign to the display_name property of this SddcSummary.
vmware_software_version (str) – The value to assign to the vmware_software_version property of this SddcSummary.
compartment_id (str) – The value to assign to the compartment_id property of this SddcSummary.
clusters_count (int) – The value to assign to the clusters_count property of this SddcSummary.
hcx_fqdn (str) – The value to assign to the hcx_fqdn property of this SddcSummary.
hcx_mode (str) – The value to assign to the hcx_mode property of this SddcSummary. Allowed values for this property are: “DISABLED”, “ADVANCED”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
vcenter_fqdn (str) – The value to assign to the vcenter_fqdn property of this SddcSummary.
nsx_manager_fqdn (str) – The value to assign to the nsx_manager_fqdn property of this SddcSummary.
time_created (datetime) – The value to assign to the time_created property of this SddcSummary.
time_updated (datetime) – The value to assign to the time_updated property of this SddcSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SddcSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_single_host_sddc (bool) – The value to assign to the is_single_host_sddc property of this SddcSummary.
sddc_byol_allocation_details (oci.ocvp.models.SddcByolAllocationDetails) – The value to assign to the sddc_byol_allocation_details property of this SddcSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SddcSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SddcSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SddcSummary.
- property clusters_count¶
[Required] Gets the clusters_count of this SddcSummary. The number of ESXi hosts in the SDDC.
- Returns
The clusters_count of this SddcSummary.
- Return type
int
- property compartment_id¶
[Required] Gets the compartment_id of this SddcSummary. The OCID of the compartment that contains the SDDC.
- Returns
The compartment_id of this SddcSummary.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this SddcSummary. 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 SddcSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this SddcSummary. A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
- Returns
The display_name of this SddcSummary.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this SddcSummary. 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 SddcSummary.
- Return type
dict(str, str)
- property hcx_fqdn¶
Gets the hcx_fqdn of this SddcSummary. HCX Fully Qualified Domain Name
- Returns
The hcx_fqdn of this SddcSummary.
- Return type
str
- property hcx_mode¶
Gets the hcx_mode of this SddcSummary. HCX configuration of the SDDC.
Allowed values for this property are: “DISABLED”, “ADVANCED”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The hcx_mode of this SddcSummary.
- Return type
str
- property id¶
[Required] Gets the id of this SddcSummary. The OCID of the compartment that contains the SDDC.
- Returns
The id of this SddcSummary.
- Return type
str
- property is_single_host_sddc¶
Gets the is_single_host_sddc of this SddcSummary. Indicates whether this SDDC is designated for only single ESXi host.
- Returns
The is_single_host_sddc of this SddcSummary.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this SddcSummary. The current state of the SDDC.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 SddcSummary.
- Return type
str
- property nsx_manager_fqdn¶
Gets the nsx_manager_fqdn of this SddcSummary. FQDN for NSX Manager
Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com
- Returns
The nsx_manager_fqdn of this SddcSummary.
- Return type
str
- property sddc_byol_allocation_details¶
Gets the sddc_byol_allocation_details of this SddcSummary.
- Returns
The sddc_byol_allocation_details of this SddcSummary.
- Return type
- property system_tags¶
Gets the system_tags of this SddcSummary. 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 SddcSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this SddcSummary. The date and time the SDDC was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this SddcSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this SddcSummary. The date and time the SDDC was updated, in the format defined by RFC3339.
- Returns
The time_updated of this SddcSummary.
- Return type
datetime
- property vcenter_fqdn¶
Gets the vcenter_fqdn of this SddcSummary. FQDN for vCenter
Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com
- Returns
The vcenter_fqdn of this SddcSummary.
- Return type
str
- property vmware_software_version¶
[Required] Gets the vmware_software_version of this SddcSummary. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see
list_supported_vmware_software_versions()).This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with
create_esxi_host().Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use
update_sddc()to update the SDDC’s vmwareSoftwareVersion with that new version.- Returns
The vmware_software_version of this SddcSummary.
- Return type
str