openapi: 3.2.0
info:
  title: Oracle Sddc API
  version: '1.0'
  description: 'Operations tagged sddc across 2 of this provider''s published API definitions: oci-vmware-1-openapi.yaml, oci-vmware-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1/20220518
- url: https://127.0.0.1/20220518
tags:
- name: sddc
paths:
  /sddcs:
    get:
      description: 'Lists the SDDCs in the specified compartment. The list can be

        filtered by display name or availability domain.

        '
      operationId: ListSddcs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/LifecycleState'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SddcCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the SDDCs in the specified compartment
      tags:
      - sddc
      x-related-resource: '#/definitions/SddcSummary'
    post:
      description: 'Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).


        Use the [WorkRequest](#/en/vmware/20200501/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](/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

        '
      operationId: CreateSddc
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the SDDC will be created.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates an SDDC
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSddcDetails'
        description: Details for the SDDC.
        required: true
  /sddcs/{sddcId}:
    delete:
      description: 'Deletes the specified SDDC, along with the other resources that were

        created with the SDDC. For example: the Compute instances, DNS records,

        and so on.


        Use the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the

        deletion of the SDDC.

        '
      operationId: DeleteSddc
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the SDDC will be deleted.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the specified SDDC
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
    get:
      description: Gets the specified SDDC's information.
      operationId: GetSddc
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The SDDC was retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sddc'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get SDDC
      tags:
      - sddc
    put:
      description: 'Updates the specified SDDC.


        **Important:** Updating an SDDC affects only certain attributes in the `Sddc`

        object and does not affect the VMware environment currently running in

        the SDDC. For more information, see

        [UpdateSddcDetails](#/en/vmware/20200501/datatypes/UpdateSddcDetails).

        '
      operationId: UpdateSddc
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The SDDC was updated.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sddc'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the specified SDDC
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSddcDetails'
        description: The information to be updated.
        required: true
  /sddcs/{sddcId}/actions/acknowledgeLicenseReplacement:
    post:
      description: Acknowledge the replacement of SDDC licenses.
      operationId: AcknowledgeSddcLicenseReplacement
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The replacement of SDDC licenses was acknowledged.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Acknowledge the replacement of SDDC licenses.
      tags:
      - sddc
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/Sddc'
  /sddcs/{sddcId}/actions/cancelDowngradeHcx:
    post:
      description: 'Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.

        '
      operationId: CancelDowngradeHcx
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted. The pending downgrade is cancelled.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
  /sddcs/{sddcId}/actions/changeCompartment:
    post:
      description: 'Moves an SDDC into a different compartment within the same tenancy. For information

        about moving resources between compartments, see

        [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeSddcCompartment
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: The SDDC has been moved to the specified compartment.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves an SDDC into a different compartment within the same tenancy
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSddcCompartmentDetails'
        description: Request to change the compartment of the specified SDDC
        required: true
  /sddcs/{sddcId}/actions/downgradeHcx:
    post:
      description: "Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. \nSDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded.\nDowngrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3.\nDowngrade remains in a `PENDING` state until the end of the current billing cycle. You can use [cancelDowngradeHcx](#/en/vmware/20200501/Sddc/CancelDowngradeHcx/) \nto cancel the downgrade while it's still in a `PENDING` state.\n"
      operationId: DowngradeHcx
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the SDDC will be downgraded at the end of the current HCX Enterprise contract.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Downgrade the specified SDDC from HCX Enterprise to HCX Advanced
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DowngradeHcxDetails'
        description: The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.
        required: true
  /sddcs/{sddcId}/actions/refreshHcxLicenses:
    post:
      description: Refresh HCX on-premise licenses status of the specified SDDC.
      operationId: RefreshHcxLicenseStatus
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted to refresh SDDC HCX on-premise licenses status.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Refresh HCX on-premise licenses status of the specified SDDC
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
  /sddcs/{sddcId}/actions/upgradeHcx:
    post:
      description: 'Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.

        '
      operationId: UpgradeHcx
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the SDDC will be upgraded.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Upgrade the specified SDDC from HCX Advanced to HCX Enterprise
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
  /supportedHostShapes:
    get:
      description: 'Lists supported compute shapes for ESXi hosts.

        '
      operationId: ListSupportedHostShapes
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/SddcTypeQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedHostShapeCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists supported compute shapes.
      tags:
      - sddc
      x-related-resource: '#/definitions/SupportedHostShapeSummary'
  /supportedSkus:
    get:
      description: 'Lists supported SKUs.

        '
      operationId: ListSupportedSkus
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/HostShapeNameQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedSkuSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists supported SKUs. HOUR, MONTH, ONE_YEAR and THREE_YEARS
      tags:
      - sddc
      x-related-resource: '#/definitions/SupportedSkuSummary'
  /supportedVmwareSoftwareVersions:
    get:
      description: 'Lists the versions of bundled VMware software supported by the Oracle Cloud

        VMware Solution.

        '
      operationId: ListSupportedVmwareSoftwareVersions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedVmwareSoftwareVersionCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the supported VMware software bundle versions
      tags:
      - sddc
      x-related-resource: '#/definitions/SupportedVmwareSoftwareVersionSummary'
  /sddcs/{sddcId}/actions/retrievePassword:
    post:
      description: 'Retrieve the SDDC password.

        '
      operationId: RetrievePassword
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierPathParam'
      - $ref: '#/components/parameters/PasswordTypeQueryParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The SDDC password was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SddcPassword'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default_2'
      summary: Retrieve the SDDC password.
      tags:
      - sddc
      x-related-resource: '#/definitions/Sddc'
  /supportedCommitments:
    get:
      description: 'Lists supported Commitments.

        '
      operationId: ListSupportedCommitments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/HostShapeNameQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedCommitmentSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default_2'
      summary: Lists supported Commitments. HOUR, MONTH, ONE_YEAR and THREE_YEARS
      tags:
      - sddc
      x-related-resource: '#/definitions/SupportedCommitmentSummary'
components:
  schemas:
    UpdateSddcDetails:
      description: 'The SDDC information to be updated.


        **Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes

        affect the existing SDDC. Changing the other attributes affects the `Sddc` object, but not

        the VMware environment currently running on that SDDC. Those other attributes are used

        by the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this

        SDDC in the future with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of 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.

            '
          maxLength: 16
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        hcxVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the HCX

            component of the VMware environment when adding new ESXi hosts to the SDDC. This value can be updated only when `isHcxEnabled` is true.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxEdgeUplink1VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the NSX Edge Uplink 1 component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxEdgeUplink2VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the NSX Edge Uplink 2 component of the VMware environment when adding new ESXi hosts to the SDDC.


            **Note:** This VLAN is reserved for future use to deploy public-facing applications on the VMware SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxEdgeVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the NSX Edge VTEP component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the NSX VTEP component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        provisioningVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the Provisioning component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        replicationVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the vSphere Replication component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        sshAuthorizedKeys:
          description: 'One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for

            the default user on each ESXi host, only when adding new ESXi hosts to this SDDC.

            Use a newline character to separate multiple keys.

            The SSH keys must be in the format required for the `authorized_keys` file.

            '
          maxLength: 4096
          minLength: 1
          type: string
        vmotionVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the vMotion component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        vmwareSoftwareVersion:
          description: 'The version of bundled VMware software that the Oracle Cloud VMware Solution will

            install on any new ESXi hosts that you add to this SDDC in the future.


            For the list of versions supported by the Oracle Cloud VMware Solution, see

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)).

            '
          maxLength: 32
          minLength: 1
          type: string
        vsanVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the vSAN component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        vsphereVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for

            the vSphere component of the VMware environment when adding new ESXi hosts to the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    SddcCollection:
      description: A list of SDDCs.
      properties:
        items:
          description: A list of SDDCs.
          items:
            $ref: '#/components/schemas/SddcSummary'
          type: array
      required:
      - items
      type: object
    VsphereUpgradeObject:
      description: 'Binary object needed for vSphere upgrade

        '
      properties:
        downloadLink:
          description: Binary object download link.
          type: string
        linkDescription:
          description: Binary object description.
          type: string
      required:
      - downloadLink
      - linkDescription
    SddcPassword:
      description: SDDC vCenter/NSX/HCX password.
      properties:
        passwordType:
          description: SDDC password type.
          enum:
          - VCENTER
          - NSX
          - HCX
          type: string
          x-obmcs-top-level-enum: '#/definitions/PasswordTypes'
        value:
          description: SDDC vCenter/NSX/HCX password context.
          type: string
      required:
      - passwordType
      - value
    SupportedHostShapeSummary:
      description: 'A specific compute shape supported by the Oracle Cloud VMware Solution.

        '
      properties:
        defaultOcpuCount:
          description: 'The default OCPU count of the shape.

            '
          format: float
          minimum: 0
          type: number
        description:
          description: 'Description of the shape.

            '
          type: string
        isSupportMonthlySku:
          default: false
          description: Whether the shape supports "MONTH" SKU.
          type: boolean
        isSupportShieldedInstances:
          default: false
          description: Indicates whether the shape supports shielded instances.
          type: boolean
        name:
          description: 'The name of the supported compute shape.

            '
          type: string
        shapeFamily:
          description: 'The family of the shape. ESXi hosts of one SDDC must have the same shape family.

            '
          type: string
        supportedOcpuCount:
          description: 'Support OCPU count of the shape.

            '
          items:
            format: float
            minimum: 0
            type: number
          type: array
        supportedOperations:
          description: 'The operations where you can use the shape. The operations can be CREATE_SDDC or CREATE_ESXI_HOST.

            '
          items:
            enum:
            - CREATE_SDDC
            - DELETE_SDDC
            - CREATE_ESXI_HOST
            - DELETE_ESXI_HOST
            - UPGRADE_HCX
            - DOWNGRADE_HCX
            - CANCEL_DOWNGRADE_HCX
            - REFRESH_HCX_LICENSE_STATUS
            - SWAP_BILLING
            type: string
            x-obmcs-top-level-enum: '#/definitions/OperationTypes'
          type: array
        supportedSddcTypes:
          description: 'The supported SDDC types for the shape.

            '
          items:
            enum:
            - PRODUCTION
            - NON_PRODUCTION
            type: string
            x-obmcs-top-level-enum: '#/definitions/SddcTypes'
          type: array
        supportedVmwareSoftwareVersions:
          description: 'The VMware software versions supported by the shape.

            '
          items:
            type: string
          type: array
      required:
      - name
      - supportedOperations
      - shapeFamily
    Error:
      description: Error Information.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    DatastoreInfo:
      description: 'Datastore info for creating an Sddc.

        '
      properties:
        blockVolumeIds:
          description: A list of [OCID](/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        datastoreType:
          description: Type of the datastore.
          enum:
          - MANAGEMENT
          - WORKLOAD
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatastoreTypes'
      required:
      - blockVolumeIds
      - datastoreType
      type: object
    SupportedCommitmentSummary:
      description: 'A specific Commitment.

        '
      properties:
        name:
          description: name of Commitment
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Commitment'
      required:
      - name
    SddcSummary:
      description: A summary of the SDDC.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the SDDC.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain that the SDDC''s ESXi hosts are running in. For Multi-AD SDDC, it is `multi-AD`.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: '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.

            '
          type: string
        esxiHostsCount:
          description: The number of ESXi hosts in the SDDC.
          type: integer
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        hcxFqdn:
          description: HCX Fully Qualified Domain Name
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the SDDC.

            '
          type: string
        initialHostOcpuCount:
          description: 'The initial OCPU count of the SDDC''s ESXi hosts.

            '
          format: float
          minimum: 0
          type: number
        initialHostShapeName:
          description: 'The initial compute shape of the SDDC''s ESXi hosts.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        isHcxEnabled:
          description: Indicates whether HCX is enabled.
          type: boolean
        isShieldedInstanceEnabled:
          default: false
          description: 'Indicates whether shielded instance is enabled at the SDDC level.

            '
          type: boolean
        isSingleHostSddc:
          default: false
          description: Indicates whether this SDDC is designated for only single ESXi host.
          type: boolean
        lifecycleState:
          description: The current state of the SDDC. Deleting all bare metal instances under a SDDC will cause SDDC transit to FAILED state.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        nsxManagerFqdn:
          description: 'FQDN for NSX Manager


            Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

            '
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the SDDC was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the SDDC was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        vcenterFqdn:
          description: 'FQDN for vCenter


            Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

            '
          type: string
        vmwareSoftwareVersion:
          description: 'In general, this is a specific version of bundled VMware software supported by

            Oracle Cloud VMware Solution (see

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `vmwareSoftwareVersion` with that new version.

            '
          type: string
      required:
      - id
      - computeAvailabilityDomain
      - compartmentId
      - displayName
      - esxiHostsCount
      - vmwareSoftwareVersion
      - freeformTags
      - definedTags
      - initialHostShapeName
      type: object
    SupportedVmwareSoftwareVersionCollection:
      description: A list of the supported versions of bundled VMware software.
      properties:
        items:
          description: A list of the supported versions of bundled VMware software.
          items:
            $ref: '#/components/schemas/SupportedVmwareSoftwareVersionSummary'
          type: array
      required:
      - items
      type: object
    VsphereLicense:
      description: 'License for vSphere upgrade.

        '
      properties:
        licenseKey:
          description: vSphere license key value.
          type: string
        licenseType:
          description: vSphere license type.
          type: string
      required:
      - licenseType
      - licenseKey
    DatastoreSummary:
      description: 'Datastore summary for a getting an Sddc.

        '
      properties:
        blockVolumeIds:
          description: A list of [OCID](/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        capacity:
          description: Size of the Block Storage Volume in GB.
          format: double
          type: number
        datastoreType:
          description: Type of the datastore.
          enum:
          - MANAGEMENT
          - WORKLOAD
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatastoreTypes'
      required:
      - blockVolumeIds
      - datastoreType
      - capacity
      type: object
    SupportedCommitmentSummaryCollection:
      description: 'A specific Commitment.

        '
      properties:
        items:
          description: A list of the supported Commitments.
          items:
            $ref: '#/components/schemas/SupportedCommitmentSummary'
          type: array
      required:
      - items
      type: object
    ChangeSddcCompartmentDetails:
      description: The configuration details for the move operation.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move

            the SDDC to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
    SupportedHostShapeCollection:
      description: A list of compute shapes supported by the Oracle Cloud VMware Solution.
      properties:
        items:
          description: A list of the supported compute shapes for ESXi hosts.
          items:
            $ref: '#/components/schemas/SupportedHostShapeSummary'
          type: array
      required:
      - items
      type: object
    SupportedSkuSummaryCollection:
      description: 'A specific SKU.

        '
      properties:
        items:
          description: A list of the supported SKUs.
          items:
            $ref: '#/components/schemas/SupportedSkuSummary'
          type: array
      required:
      - items
      type: object
    DowngradeHcxDetails:
      description: 'The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.

        Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3.

        '
      properties:
        reservingHcxOnPremiseLicenseKeys:
          description: 'The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.

            '
          items:
            type: string
          maxItems: 3
          type: array
      required:
      - reservingHcxOnPremiseLicenseKeys
      type: object
    CreateSddcDetails:
      description: Details of the SDDC.
      properties:
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain to create the SDDC''s ESXi hosts in. For multi-AD SDDC deployment, set to `multi-AD`.

            '
          maxLength: 64
          minLength: 1
          type: string
        datastores:
          description: 'A list of datastore info for the SDDC.

            This value is required only when `initialHostShapeName` is a standard shape.

            '
          items:
            $ref: '#/components/schemas/DatastoreInfo'
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: '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.

            '
          maxLength: 16
          minLength: 1
          type: string
        esxiHostsCount:
          description: 'The number of ESXi hosts to create in the SDDC. You can add more hosts later

            (see [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/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.

            '
          maximum: 64
          minimum: 1
          type: integer
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        hcxVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the HCX

            component of the VMware environment. This value is required only when `isHcxEnabled` is true.

            '
          maxLength: 255
          minLength: 1
          type: string
        initialHostOcpuCount:
          description: 'The initial OCPU count of the SDDC''s ESXi hosts.

            '
          format: float
          minimum: 0
          type: number
          x-default-description: When unspecified, it will use the default OCPU count of the initial ESXi host shape.
        initialHostShapeName:
          default: BM.DenseIO2.52
          description: 'The initial compute shape of the SDDC''s ESXi hosts.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        initialSku:
          description: 'The billing option selected during SDDC creation.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: For ESXi host shapes supporting "MONTH" SKU, the default initialSku is "MONTH". For other shapes, the default initialSku is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Sku'
        instanceDisplayNamePrefix:
          description: '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.

            '
          maxLength: 127
          minLength: 1
          type: string
        isHcxEnabled:
          default: false
          description: '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`.

            '
          type: boolean
        isHcxEnterpriseEnabled:
          default: false
          description: 'Indicates whether to enable HCX Enterprise for this SDDC.

            '
          type: boolean
        isShieldedInstanceEnabled:
          default: false
          description: 'Indicates whether shielded instance is enabled for this SDDC.

            '
          type: boolean
        isSingleHostSddc:
          default: false
          description: 'Indicates whether this SDDC is designated for only single ESXi host.

            '
          type: boolean
        nsxEdgeUplink1VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge

            Uplink 1 component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxEdgeUplink2VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxEdgeVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge VTEP

            component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        nsxVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX VTEP

            component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        provisioningSubnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management subnet to use

            for provisioning the SDDC.

            '
          maxLength: 255
          minLength: 1
          type: string
        provisioningVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the Provisioning component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        replicationVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the vSphere Replication component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        sshAuthorizedKeys:
          description: '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

            '
          maxLength: 4096
          minLength: 1
          type: string
        vmotionVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vMotion

            component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        vmwareBillingLinkId:
          description: 'This is an optional paramter.  If this parameter is not empty, then the billing of this SDDC will be

            to VMware.  The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware billing link.

            '
          maxLength: 255
          minLength: 1
          type: string
        vmwareSoftwareVersion:
          description: 'The VMware software bundle to install on the ESXi hosts in the SDDC. To get a

            list of the available versions, use

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).

            '
          maxLength: 32
          minLength: 1
          type: string
        vsanVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSAN

            component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        vsphereVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSphere

            component of the VMware environment.

            '
          maxLength: 255
          minLength: 1
          type: string
        workloadNetworkCidr:
          description: 'The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application

            workloads.

            '
          maxLength: 20
          minLength: 1
          type: string
      required:
      - computeAvailabilityDomain
      - vmwareSoftwareVersion
      - compartmentId
      - esxiHostsCount
      - provisioningSubnetId
      - vsphereVlanId
      - vmotionVlanId
      - vsanVlanId
      - nsxVTepVlanId
      - nsxEdgeVTepVlanId
      - nsxEdgeUplink1VlanId
      - nsxEdgeUplink2VlanId
      - sshAuthorizedKeys
      type: object
    SupportedVmwareSoftwareVersionSummary:
      description: 'A specific version of bundled VMware software supported by the Oracle Cloud

        VMware Solution.

        '
      properties:
        description:
          description: A description of the software in the bundle.
          type: string
        version:
          description: 'A short, unique string that identifies the version of bundled software.

            '
          type: string
      required:
      - version
      - description
    SupportedSkuSummary:
      description: 'A specific SKU.

        '
      properties:
        name:
          description: name of SKU
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Sku'
      required:
      - name
    HcxLicenseSummary:
      description: 'HCX on-premise license information summary.

        '
      properties:
        activationKey:
          description: HCX on-premise license key value.
          type: string
        status:
          description: status of HCX on-premise license.
          enum:
          - AVAILABLE
          - CONSUMED
          - DEACTIVATED
          - DELETED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HcxLicenseStatus'
        systemName:
          description: Name of the system that consumed the HCX on-premise license
          type: string
      required:
      - activationKey
      - status
    Sddc:
      description: 'An [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm) software-defined data center (SDDC) contains the resources required for a

        functional VMware environment. Instances in an SDDC

        (see [EsxiHost](#/en/vmware/20200501/EsxiHost/)) run in a virtual cloud network (VCN)

        and are preconfigured with VMware and storage. Use the vCenter utility to manage

        and deploy VMware virtual machines (VMs) in the SDDC.


        The SDDC uses a single management subnet for provisioning the SDDC. It also uses a

        set of VLANs for various components of the VMware environment (vSphere, vMotion,

        vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.

        '
      properties:
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the SDDC.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain the ESXi hosts are running in. For Multi-AD SDDC, it is `multi-AD`.


            Example: `Uocm:PHX-AD-1`, `multi-AD`

            '
          type: string
        datastores:
          description: 'Datastores used for the Sddc.

            '
          items:
            $ref: '#/components/schemas/DatastoreSummary'
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: '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.

            '
          type: string
        esxiHostsCount:
          description: The number of ESXi hosts in the SDDC.
          type: integer
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        hcxFqdn:
          description: 'The FQDN for HCX Manager.


            Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

            '
          type: string
        hcxInitialPassword:
          description: '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.

            '
          type: string
        hcxOnPremKey:
          description: '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.

            '
          type: string
        hcxOnPremLicenses:
          description: 'The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.

            '
          items:
            $ref: '#/components/schemas/HcxLicenseSummary'
          type: array
        hcxPrivateIpId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is

            the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the

            Core Services API.

            '
          type: string
        hcxVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `hcxVlanId` with that new VLAN''s OCID.

            '
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.

            '
          type: string
        initialHostOcpuCount:
          description: 'The initial OCPU count of the SDDC''s ESXi hosts.

            '
          format: float
          minimum: 0
          type: number
        initialHostShapeName:
          description: 'The initial compute shape of the SDDC''s ESXi hosts.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        initialSku:
          description: 'The billing option selected during SDDC creation.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: For ESXi host shapes supporting "MONTH" SKU, the default initialSku is "MONTH". For other shapes, the default initialSku is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Sku'
        instanceDisplayNamePrefix:
          description: '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.

            '
          type: string
        isHcxEnabled:
          description: Indicates whether HCX is enabled for this SDDC.
          type: boolean
        isHcxEnterpriseEnabled:
          default: false
          description: Indicates whether HCX Enterprise is enabled for this SDDC.
          type: boolean
        isHcxPendingDowngrade:
          default: false
          description: Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.
          type: boolean
        isShieldedInstanceEnabled:
          default: false
          description: 'Indicates whether shielded instance is enabled at the SDDC level.

            '
          type: boolean
        isSingleHostSddc:
          default: false
          description: Indicates whether this SDDC is designated for only single ESXi host.
          type: boolean
        lifecycleDetails:
          description: 'The detailed lifecycle of the licenses of the resource.

            '
          type: string
        lifecycleState:
          description: The current state of the SDDC. Deleting all bare metal instances under a SDDC will cause SDDC transit to FAILED state.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        nsxEdgeUplink1VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `nsxEdgeUplink1VlanId` with that new VLAN''s OCID.

            '
          type: string
        nsxEdgeUplink2VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `nsxEdgeUplink2VlanId` with that new VLAN''s OCID.

            '
          type: string
        nsxEdgeUplinkIpId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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.

            '
          type: string
        nsxEdgeVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `nsxEdgeVTepVlanId` with that new VLAN''s OCID.

            '
          type: string
        nsxManagerFqdn:
          description: 'The FQDN for NSX Manager.


            Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

            '
          type: string
        nsxManagerInitialPassword:
          description: '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.

            '
          type: string
        nsxManagerPrivateIpId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is

            the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the

            Core Services API.

            '
          type: string
        nsxManagerUsername:
          description: '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.

            '
          type: string
        nsxOverlaySegmentName:
          description: 'The VMware NSX overlay workload segment to host your application. Connect to workload

            portgroup in vCenter to access this overlay segment.

            '
          type: string
        nsxVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `nsxVTepVlanId` with that new VLAN''s OCID.

            '
          type: string
        provisioningSubnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management subnet used

            to provision the SDDC.

            '
          type: string
        provisioningVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the Provisioning component of the VMware environment.

            '
          type: string
        replacementLicenses:
          description: 'Replacement licenses for ESXi hosts scaled from less or equal then 64 OCPUs to more than 64 OCPUs.

            '
          items:
            $ref: '#/components/schemas/LicenseDetails'
          type: array
        replicationVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the vSphere Replication component of the VMware environment.

            '
          type: string
        sshAuthorizedKeys:
          description: '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](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different

            SSH keys, you should use [UpdateSddc](#/en/vmware/20200501/Sddc/UpdateSddc) to update

            the SDDC''s `sshAuthorizedKeys` with the new public keys.

            '
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the SDDC was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeHcxBillingCycleEnd:
          description: 'The date and time current HCX Enterprise billing cycle ends, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeHcxLicenseStatusUpdated:
          description: 'The date and time the SDDC''s HCX on-premise license status was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the SDDC was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        upgradeLicenses:
          description: 'The vSphere licenses to use when upgrading the SDDC.

            '
          items:
            $ref: '#/components/schemas/VsphereLicense'
          type: array
        vcenterFqdn:
          description: 'The FQDN for vCenter.


            Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`

            '
          type: string
        vcenterInitialPassword:
          description: 'The SDDC includes an administrator username and initial password for vCenter. Make sure

            to change this initial vCenter password to a different value.

            '
          type: string
        vcenterPrivateIpId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is

            the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the

            Core Services API.

            '
          type: string
        vcenterUsername:
          description: 'The SDDC includes an administrator username and initial password for vCenter. You can

            change this initial username to a different value in vCenter.

            '
          type: string
        vmotionVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `vmotionVlanId` with that new VLAN''s OCID.

            '
          type: string
        vmwareBillingLinkId:
          description: "If not empty, then the billing of this SDDC will be to VMware.  \nThe [OCID](/Content/General/Concepts/identifiers.htm) of the VMware billing link.\n"
          maxLength: 255
          minLength: 1
          type: string
        vmwareSoftwareVersion:
          description: 'In general, this is a specific version of bundled VMware software supported by

            Oracle Cloud VMware Solution (see

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `vmwareSoftwareVersion` with that new version.

            '
          type: string
        vsanVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `vsanVlanId` with that new VLAN''s OCID.

            '
          type: string
        vsphereUpgradeGuide:
          description: 'The link to guidance for upgrading vSphere.

            '
          type: string
        vsphereUpgradeObjects:
          description: 'The links to binary objects needed to upgrade vSphere.

            '
          items:
            $ref: '#/components/schemas/VsphereUpgradeObject'
          type: array
        vsphereVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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](#/en/vmware/20200501/EsxiHost/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](#/en/vmware/20200501/Sddc/UpdateSddc) to update the SDDC''s

            `vsphereVlanId` with that new VLAN''s OCID.

            '
          type: string
        workloadNetworkCidr:
          description: 'The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application

            workloads.

            '
          type: string
      required:
      - id
      - computeAvailabilityDomain
      - displayName
      - vmwareSoftwareVersion
      - compartmentId
      - esxiHostsCount
      - sshAuthorizedKeys
      - vcenterFqdn
      - nsxManagerFqdn
      - vcenterPrivateIpId
      - nsxManagerPrivateIpId
      - provisioningSubnetId
      - vsphereVlanId
      - vmotionVlanId
      - vsanVlanId
      - nsxVTepVlanId
      - nsxEdgeVTepVlanId
      - nsxEdgeUplink1VlanId
      - nsxEdgeUplink2VlanId
      - freeformTags
      - definedTags
      - timeCreated
      - initialHostShapeName
      type: object
    LicenseDetails:
      description: 'Details of a license.

        '
      properties:
        licenseDescription:
          description: Description of the license.
          type: string
        licenseKey:
          description: License key value.
          type: string
        licenseType:
          description: License type.
          type: string
      required:
      - licenseType
      - licenseKey
  parameters:
    AvailabilityDomainQueryParam:
      description: 'The name of the availability domain that the Compute instances are running in.


        Example: `Uocm:PHX-AD-1`

        '
      in: query
      name: computeAvailabilityDomain
      required: false
      x-default-description: 'null'
      schema:
        type: string
    NameQueryParam:
      description: A filter to return only resources that match the given name exactly.
      in: query
      name: name
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for

        TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME

        sort order is case sensitive.


        **Note:** In general, some "List" operations (for example, `ListInstances`) let you

        optionally filter by availability domain if the scope of the resource type is within a

        single availability domain. If you call one of these "List" operations without specifying

        an availability domain, the resources are grouped by availability domain, then sorted.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"

        call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    CompartmentIdQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    SddcTypeQueryParam:
      description: A filter to return only resources that match the given SDDC type exactly.
      in: query
      name: sddcType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SddcTypes'
      schema:
        type: string
        enum:
        - PRODUCTION
        - NON_PRODUCTION
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order

        is case sensitive.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    HostShapeNameQueryParam:
      description: A filter to return only resources that match or support the given ESXi host shape.
      in: query
      name: hostShapeName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader_2:
      description: 'Unique identifier for the request. If you need to contact Oracle about a particular

        request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations (for example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    PasswordTypeQueryParam:
      description: The SDDC password type.
      in: query
      name: type
      required: true
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/PasswordTypes'
      schema:
        type: string
        enum:
        - VCENTER
        - NSX
        - HCX
    DisplayNameQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleState:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    SddcIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.

        '
      in: path
      name: sddcId
      required: true
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        Sunset:
          description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
          schema:
            type: string
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    default_2:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- oci-vmware-1-openapi.yaml
- oci-vmware-openapi.yaml
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.idm.agcs.cp