oracle.oci.oci_ocvp_sddc – Manage a Sddc resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_ocvp_sddc.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Sddc resource in Oracle Cloud Infrastructure

  • For state=present, creates an Oracle Cloud VMware Solution software-defined data center (SDDC).

  • Use the WorkRequest operations to track the creation of the SDDC.

  • Important: You must configure the SDDC’s networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs. Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

  • This resource has the following action operations in the oracle.oci.oci_ocvp_sddc_actions module: cancel_downgrade_hcx, change_compartment, downgrade_hcx, refresh_hcx_license_status, upgrade_hcx.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
capacity_reservation_id
string
The OCID of the Capacity Reservation.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment to contain the SDDC.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
compute_availability_domain
string
The availability domain to create the SDDC's ESXi hosts in. For multi-AD SDDC deployment, set to `multi-AD`.
Required for create using state=present.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
datastores
list / elements=dictionary
A list of datastore info for the SDDC. This value is required only when `initialHostShapeName` is a standard shape.
block_volume_ids
list / elements=string / required
A list of OCIDs of Block Storage Volumes.
datastore_type
string / required
    Choices:
  • MANAGEMENT
  • WORKLOAD
Type of the datastore.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A descriptive name for the SDDC. SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
esxi_hosts_count
integer
The number of ESXi hosts to create in the SDDC. You can add more hosts later (see CreateEsxiHost). Creating a SDDC with a ESXi host count of 1 will be considered a single ESXi host SDDC.
**Note:** If you later delete EXSi hosts from a production SDDC to total less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the SDDC until it again has at least 3 ESXi hosts.
Required for create using state=present.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
hcx_vlan_id
string
The OCID of the VLAN to use for the HCX component of the VMware environment. This value is required only when `isHcxEnabled` is true.
This parameter is updatable.
initial_host_ocpu_count
float
The initial OCPU count of the SDDC's ESXi hosts.
initial_host_shape_name
string
The initial compute shape of the SDDC's ESXi hosts. ListSupportedHostShapes.
initial_sku
string
    Choices:
  • HOUR
  • MONTH
  • ONE_YEAR
  • THREE_YEARS
The billing option selected during SDDC creation. ListSupportedSkus.
instance_display_name_prefix
string
A prefix used in the name of each ESXi host and Compute instance in the SDDC. If this isn't set, the SDDC's `displayName` is used as the prefix.
For example, if the value is `mySDDC`, the ESXi hosts are named `mySDDC-1`, `mySDDC-2`, and so on.
is_hcx_enabled
boolean
    Choices:
  • no
  • yes
For SDDC with dense compute shapes, this parameter indicates whether to enable HCX Advanced for this SDDC. For SDDC with standard compute shapes, this parameter is equivalent to `isHcxEnterpriseEnabled`.
is_hcx_enterprise_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether to enable HCX Enterprise for this SDDC.
is_shielded_instance_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether shielded instance is enabled for this SDDC.
is_single_host_sddc
boolean
    Choices:
  • no
  • yes
Indicates whether this SDDC is designated for only single ESXi host.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
nsx_edge_uplink1_vlan_id
string
The OCID of the VLAN to use for the NSX Edge Uplink 1 component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
nsx_edge_uplink2_vlan_id
string
The OCID of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment.
**Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC.
Required for create using state=present.
This parameter is updatable.
nsx_edge_v_tep_vlan_id
string
The OCID of the VLAN to use for the NSX Edge VTEP component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
nsx_v_tep_vlan_id
string
The OCID of the VLAN to use for the NSX VTEP component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
provisioning_subnet_id
string
The OCID of the management subnet to use for provisioning the SDDC.
Required for create using state=present.
provisioning_vlan_id
string
The OCID of the VLAN used by the SDDC for the Provisioning component of the VMware environment.
This parameter is updatable.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
replication_vlan_id
string
The OCID of the VLAN used by the SDDC for the vSphere Replication component of the VMware environment.
This parameter is updatable.
sddc_id
string
The OCID of the SDDC.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
ssh_authorized_keys
string
One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the `authorized_keys` file
Required for create using state=present.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the Sddc.
Use state=present to create or update a Sddc.
Use state=absent to delete a Sddc.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
vmotion_vlan_id
string
The OCID of the VLAN to use for the vMotion component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
vmware_software_version
string
The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions.
Required for create using state=present.
This parameter is updatable.
vsan_vlan_id
string
The OCID of the VLAN to use for the vSAN component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
vsphere_vlan_id
string
The OCID of the VLAN to use for the vSphere component of the VMware environment.
Required for create using state=present.
This parameter is updatable.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
workload_network_cidr
string
The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

Examples

- name: Create sddc
  oci_ocvp_sddc:
    # required
    compute_availability_domain: Uocm:PHX-AD-1
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    esxi_hosts_count: 56
    provisioning_subnet_id: "ocid1.provisioningsubnet.oc1..xxxxxxEXAMPLExxxxxx"
    vmware_software_version: vmware_software_version_example
    ssh_authorized_keys: ssh_authorized_keys_example
    vsphere_vlan_id: "ocid1.vspherevlan.oc1..xxxxxxEXAMPLExxxxxx"
    vmotion_vlan_id: "ocid1.vmotionvlan.oc1..xxxxxxEXAMPLExxxxxx"
    vsan_vlan_id: "ocid1.vsanvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_v_tep_vlan_id: "ocid1.nsxvtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_v_tep_vlan_id: "ocid1.nsxedgevtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink1_vlan_id: "ocid1.nsxedgeuplink1vlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink2_vlan_id: "ocid1.nsxedgeuplink2vlan.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    instance_display_name_prefix: instance_display_name_prefix_example
    initial_sku: HOUR
    is_hcx_enabled: true
    is_hcx_enterprise_enabled: true
    is_single_host_sddc: true
    workload_network_cidr: workload_network_cidr_example
    initial_host_shape_name: initial_host_shape_name_example
    initial_host_ocpu_count: 3.4
    is_shielded_instance_enabled: true
    capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
    datastores:
    - # required
      block_volume_ids: [ "block_volume_ids_example" ]
      datastore_type: MANAGEMENT
    display_name: display_name_example
    replication_vlan_id: "ocid1.replicationvlan.oc1..xxxxxxEXAMPLExxxxxx"
    provisioning_vlan_id: "ocid1.provisioningvlan.oc1..xxxxxxEXAMPLExxxxxx"
    hcx_vlan_id: "ocid1.hcxvlan.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update sddc
  oci_ocvp_sddc:
    # required
    sddc_id: "ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    vmware_software_version: vmware_software_version_example
    ssh_authorized_keys: ssh_authorized_keys_example
    vsphere_vlan_id: "ocid1.vspherevlan.oc1..xxxxxxEXAMPLExxxxxx"
    vmotion_vlan_id: "ocid1.vmotionvlan.oc1..xxxxxxEXAMPLExxxxxx"
    vsan_vlan_id: "ocid1.vsanvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_v_tep_vlan_id: "ocid1.nsxvtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_v_tep_vlan_id: "ocid1.nsxedgevtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink1_vlan_id: "ocid1.nsxedgeuplink1vlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink2_vlan_id: "ocid1.nsxedgeuplink2vlan.oc1..xxxxxxEXAMPLExxxxxx"
    replication_vlan_id: "ocid1.replicationvlan.oc1..xxxxxxEXAMPLExxxxxx"
    provisioning_vlan_id: "ocid1.provisioningvlan.oc1..xxxxxxEXAMPLExxxxxx"
    hcx_vlan_id: "ocid1.hcxvlan.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update sddc using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_ocvp_sddc:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    vmware_software_version: vmware_software_version_example
    ssh_authorized_keys: ssh_authorized_keys_example
    vsphere_vlan_id: "ocid1.vspherevlan.oc1..xxxxxxEXAMPLExxxxxx"
    vmotion_vlan_id: "ocid1.vmotionvlan.oc1..xxxxxxEXAMPLExxxxxx"
    vsan_vlan_id: "ocid1.vsanvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_v_tep_vlan_id: "ocid1.nsxvtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_v_tep_vlan_id: "ocid1.nsxedgevtepvlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink1_vlan_id: "ocid1.nsxedgeuplink1vlan.oc1..xxxxxxEXAMPLExxxxxx"
    nsx_edge_uplink2_vlan_id: "ocid1.nsxedgeuplink2vlan.oc1..xxxxxxEXAMPLExxxxxx"
    replication_vlan_id: "ocid1.replicationvlan.oc1..xxxxxxEXAMPLExxxxxx"
    provisioning_vlan_id: "ocid1.provisioningvlan.oc1..xxxxxxEXAMPLExxxxxx"
    hcx_vlan_id: "ocid1.hcxvlan.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete sddc
  oci_ocvp_sddc:
    # required
    sddc_id: "ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete sddc using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_ocvp_sddc:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
sddc
complex
on success
Details of the Sddc resource acted upon by the current operation

Sample:
{'capacity_reservation_id': 'ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_availability_domain': 'Uocm:PHX-AD-1', 'datastores': [{'block_volume_ids': [], 'capacity': 1.2, 'datastore_type': 'MANAGEMENT'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'esxi_hosts_count': 56, 'freeform_tags': {'Department': 'Finance'}, 'hcx_fqdn': 'hcx_fqdn_example', 'hcx_initial_password': 'example-password', 'hcx_on_prem_key': 'hcx_on_prem_key_example', 'hcx_on_prem_licenses': [{'activation_key': 'activation_key_example', 'status': 'AVAILABLE', 'system_name': 'system_name_example'}], 'hcx_private_ip_id': 'ocid1.hcxprivateip.oc1..xxxxxxEXAMPLExxxxxx', 'hcx_vlan_id': 'ocid1.hcxvlan.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'initial_host_ocpu_count': 3.4, 'initial_host_shape_name': 'initial_host_shape_name_example', 'initial_sku': 'HOUR', 'instance_display_name_prefix': 'instance_display_name_prefix_example', 'is_hcx_enabled': True, 'is_hcx_enterprise_enabled': True, 'is_hcx_pending_downgrade': True, 'is_shielded_instance_enabled': True, 'is_single_host_sddc': True, 'lifecycle_state': 'CREATING', 'nsx_edge_uplink1_vlan_id': 'ocid1.nsxedgeuplink1vlan.oc1..xxxxxxEXAMPLExxxxxx', 'nsx_edge_uplink2_vlan_id': 'ocid1.nsxedgeuplink2vlan.oc1..xxxxxxEXAMPLExxxxxx', 'nsx_edge_uplink_ip_id': 'ocid1.nsxedgeuplinkip.oc1..xxxxxxEXAMPLExxxxxx', 'nsx_edge_v_tep_vlan_id': 'ocid1.nsxedgevtepvlan.oc1..xxxxxxEXAMPLExxxxxx', 'nsx_manager_fqdn': 'nsx_manager_fqdn_example', 'nsx_manager_initial_password': 'example-password', 'nsx_manager_private_ip_id': 'ocid1.nsxmanagerprivateip.oc1..xxxxxxEXAMPLExxxxxx', 'nsx_manager_username': 'nsx_manager_username_example', 'nsx_overlay_segment_name': 'nsx_overlay_segment_name_example', 'nsx_v_tep_vlan_id': 'ocid1.nsxvtepvlan.oc1..xxxxxxEXAMPLExxxxxx', 'provisioning_subnet_id': 'ocid1.provisioningsubnet.oc1..xxxxxxEXAMPLExxxxxx', 'provisioning_vlan_id': 'ocid1.provisioningvlan.oc1..xxxxxxEXAMPLExxxxxx', 'replication_vlan_id': 'ocid1.replicationvlan.oc1..xxxxxxEXAMPLExxxxxx', 'ssh_authorized_keys': 'ssh_authorized_keys_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_hcx_billing_cycle_end': '2013-10-20T19:20:30+01:00', 'time_hcx_license_status_updated': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'upgrade_licenses': [{'license_key': 'license_key_example', 'license_type': 'license_type_example'}], 'vcenter_fqdn': 'vcenter_fqdn_example', 'vcenter_initial_password': 'example-password', 'vcenter_private_ip_id': 'ocid1.vcenterprivateip.oc1..xxxxxxEXAMPLExxxxxx', 'vcenter_username': 'vcenter_username_example', 'vmotion_vlan_id': 'ocid1.vmotionvlan.oc1..xxxxxxEXAMPLExxxxxx', 'vmware_software_version': 'vmware_software_version_example', 'vsan_vlan_id': 'ocid1.vsanvlan.oc1..xxxxxxEXAMPLExxxxxx', 'vsphere_upgrade_guide': 'vsphere_upgrade_guide_example', 'vsphere_upgrade_objects': [{'download_link': 'download_link_example', 'link_description': 'link_description_example'}], 'vsphere_vlan_id': 'ocid1.vspherevlan.oc1..xxxxxxEXAMPLExxxxxx', 'workload_network_cidr': 'workload_network_cidr_example'}
 
capacity_reservation_id
string
on success
The OCID of the Capacity Reservation.

Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment that contains the SDDC.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
compute_availability_domain
string
on success
The availability domain the ESXi hosts are running in. For Multi-AD SDDC, it is `multi-AD`.
Example: `Uocm:PHX-AD-1`, `multi-AD`

Sample:
Uocm:PHX-AD-1
 
datastores
complex
on success
Datastores used for the Sddc.
   
block_volume_ids
list / elements=string
on success
A list of OCIDs of Block Storage Volumes.
   
capacity
float
on success
Size of the Block Storage Volume in GB.

Sample:
1.2
   
datastore_type
string
on success
Type of the datastore.

Sample:
MANAGEMENT
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
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.

Sample:
display_name_example
 
esxi_hosts_count
integer
on success
The number of ESXi hosts in the SDDC.

Sample:
56
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
hcx_fqdn
string
on success
The FQDN for HCX Manager.
Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

Sample:
hcx_fqdn_example
 
hcx_initial_password
string
on success
The SDDC includes an administrator username and initial password for HCX Manager. Make sure to change this initial HCX Manager password to a different value.

Sample:
example-password
 
hcx_on_prem_key
string
on success
The activation keys to use on the on-premises HCX Enterprise appliances you site pair with HCX Manager in your VMware Solution. The number of keys provided depends on the HCX license type. HCX Advanced provides 3 activation keys. HCX Enterprise provides 10 activation keys.

Sample:
hcx_on_prem_key_example
 
hcx_on_prem_licenses
complex
on success
The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.
   
activation_key
string
on success
HCX on-premise license key value.

Sample:
activation_key_example
   
status
string
on success
status of HCX on-premise license.

Sample:
AVAILABLE
   
system_name
string
on success
Name of the system that consumed the HCX on-premise license

Sample:
system_name_example
 
hcx_private_ip_id
string
on success
The OCID of the `PrivateIp` object that is the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the Core Services API.

Sample:
ocid1.hcxprivateip.oc1..xxxxxxEXAMPLExxxxxx
 
hcx_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment.
This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use UpdateSddc to update the SDDC's `hcxVlanId` with that new VLAN's OCID.

Sample:
ocid1.hcxvlan.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of the SDDC.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
initial_host_ocpu_count
float
on success
The initial OCPU count of the SDDC's ESXi hosts.

Sample:
3.4
 
initial_host_shape_name
string
on success
The initial compute shape of the SDDC's ESXi hosts. ListSupportedHostShapes.

Sample:
initial_host_shape_name_example
 
initial_sku
string
on success
The billing option selected during SDDC creation. ListSupportedSkus.

Sample:
HOUR
 
instance_display_name_prefix
string
on success
A prefix used in the name of each ESXi host and Compute instance in the SDDC. If this isn't set, the SDDC's `displayName` is used as the prefix.
For example, if the value is `MySDDC`, the ESXi hosts are named `MySDDC-1`, `MySDDC-2`, and so on.

Sample:
instance_display_name_prefix_example
 
is_hcx_enabled
boolean
on success
Indicates whether HCX is enabled for this SDDC.

Sample:
True
 
is_hcx_enterprise_enabled
boolean
on success
Indicates whether HCX Enterprise is enabled for this SDDC.

Sample:
True
 
is_hcx_pending_downgrade
boolean
on success
Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.

Sample:
True
 
is_shielded_instance_enabled
boolean
on success
Indicates whether shielded instance is enabled at the SDDC level.

Sample:
True
 
is_single_host_sddc
boolean
on success
Indicates whether this SDDC is designated for only single ESXi host.

Sample:
True
 
lifecycle_state
string
on success
The current state of the SDDC.

Sample:
CREATING
 
nsx_edge_uplink1_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment.
This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use UpdateSddc to update the SDDC's `nsxEdgeUplink1VlanId` with that new VLAN's OCID.

Sample:
ocid1.nsxedgeuplink1vlan.oc1..xxxxxxEXAMPLExxxxxx
 
nsx_edge_uplink2_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment.
This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use UpdateSddc to update the SDDC's `nsxEdgeUplink2VlanId` with that new VLAN's OCID.

Sample:
ocid1.nsxedgeuplink2vlan.oc1..xxxxxxEXAMPLExxxxxx
  nsx_edge_uplink_ip_id
string
on success
The OCID of the `PrivateIp` object that is the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for route table rules when setting up connectivity between the SDDC and other networks. For information about `PrivateIp` objects, see the Core Services API.

Sample:
ocid1.nsxedgeuplinkip.oc1..xxxxxxEXAMPLExxxxxx
 
nsx_edge_v_tep_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the NSX Edge VTEP component of the VMware environment.
This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use UpdateSddc to update the SDDC's `nsxEdgeVTepVlanId` with that new VLAN's OCID.

Sample:
ocid1.nsxedgevtepvlan.oc1..xxxxxxEXAMPLExxxxxx
 
nsx_manager_fqdn
string
on success
The FQDN for NSX Manager.
Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

Sample:
nsx_manager_fqdn_example
 
nsx_manager_initial_password
string
on success
The SDDC includes an administrator username and initial password for NSX Manager. Make sure to change this initial NSX Manager password to a different value.

Sample:
example-password
 
nsx_manager_private_ip_id
string
on success
The OCID of the `PrivateIp` object that is the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the Core Services API.

Sample:
ocid1.nsxmanagerprivateip.oc1..xxxxxxEXAMPLExxxxxx
 
nsx_manager_username
string
on success
The SDDC includes an administrator username and initial password for NSX Manager. You can change this initial username to a different value in NSX Manager.

Sample:
nsx_manager_username_example
 
nsx_overlay_segment_name
string
on success
The VMware NSX overlay workload segment to host your application. Connect to workload portgroup in vCenter to access this overlay segment.

Sample:
nsx_overlay_segment_name_example
 
nsx_v_tep_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the NSX VTEP component of the VMware environment.
This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX VTEP component of the VMware environment, you should use UpdateSddc to update the SDDC's `nsxVTepVlanId` with that new VLAN's OCID.

Sample:
ocid1.nsxvtepvlan.oc1..xxxxxxEXAMPLExxxxxx
 
provisioning_subnet_id
string
on success
The OCID of the management subnet used to provision the SDDC.

Sample:
ocid1.provisioningsubnet.oc1..xxxxxxEXAMPLExxxxxx
 
provisioning_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the Provisioning component of the VMware environment.

Sample:
ocid1.provisioningvlan.oc1..xxxxxxEXAMPLExxxxxx
 
replication_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the vSphere Replication component of the VMware environment.

Sample:
ocid1.replicationvlan.oc1..xxxxxxEXAMPLExxxxxx
 
ssh_authorized_keys
string
on success
One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the `authorized_keys` file.
This attribute is not guaranteed to reflect the public SSH keys currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the public SSH keys that Oracle Cloud VMware Solution will install on any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use UpdateSddc to update the SDDC's `sshAuthorizedKeys` with the new public keys.

Sample:
ssh_authorized_keys_example
 
time_created
string
on success
The date and time the SDDC was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_hcx_billing_cycle_end
string
on success
The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_hcx_license_status_updated
string
on success
The date and time the SDDC's HCX on-premise license status was updated, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the SDDC was updated, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
upgrade_licenses
complex
on success
The vSphere licenses to use when upgrading the SDDC.
   
license_key
string
on success
vSphere license key value.

Sample:
license_key_example
   
license_type
string
on success
vSphere license type.

Sample:
license_type_example
 
vcenter_fqdn
string
on success
The FQDN for vCenter.
Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

Sample:
vcenter_fqdn_example
 
vcenter_initial_password
string
on success
The SDDC includes an administrator username and initial password for vCenter. Make sure to change this initial vCenter password to a different value.

Sample:
example-password
 
vcenter_private_ip_id
string
on success
The OCID of the `PrivateIp` object that is the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the Core Services API.

Sample:
ocid1.vcenterprivateip.oc1..xxxxxxEXAMPLExxxxxx
 
vcenter_username
string
on success
The SDDC includes an administrator username and initial password for vCenter. You can change this initial username to a different value in vCenter.

Sample:
vcenter_username_example
 
vmotion_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the vMotion component of the VMware environment.
This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vMotion component of the VMware environment, you should use UpdateSddc to update the SDDC's `vmotionVlanId` with that new VLAN's OCID.

Sample:
ocid1.vmotionvlan.oc1..xxxxxxEXAMPLExxxxxx
 
vmware_software_version
string
on success
In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
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 CreateEsxiHost.
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 UpdateSddc to update the SDDC's `vmwareSoftwareVersion` with that new version.

Sample:
vmware_software_version_example
 
vsan_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the vSAN component of the VMware environment.
This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vSAN component of the VMware environment, you should use UpdateSddc to update the SDDC's `vsanVlanId` with that new VLAN's OCID.

Sample:
ocid1.vsanvlan.oc1..xxxxxxEXAMPLExxxxxx
 
vsphere_upgrade_guide
string
on success
The link to guidance for upgrading vSphere.

Sample:
vsphere_upgrade_guide_example
 
vsphere_upgrade_objects
complex
on success
The links to binary objects needed to upgrade vSphere.
    download_link
string
on success
Binary object download link.

Sample:
download_link_example
    link_description
string
on success
Binary object description.

Sample:
link_description_example
 
vsphere_vlan_id
string
on success
The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment.
This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with CreateEsxiHost.
Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vSphere component of the VMware environment, you should use UpdateSddc to update the SDDC's `vsphereVlanId` with that new VLAN's OCID.

Sample:
ocid1.vspherevlan.oc1..xxxxxxEXAMPLExxxxxx
 
workload_network_cidr
string
on success
The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

Sample:
workload_network_cidr_example


Authors

  • Oracle (@oracle)