openapi: 3.0.0
info:
  title: Telco Cloud Foundation Manager API
  description: Telco Cloud Foundation Manager API
  termsOfService: https://www.vmware.com/help/legal.html
  contact:
    name: VMware
  license:
    name: "Copyright (c) 2020-2021 VMware, Inc. All rights reserved."
  version: "1.0"
servers:
- url: /hybridity/api/
tags:
- name: CloudSpecification
  description: Telco Cloud Definition (TCD)
paths:
  /ztp/scheme1/config:
    get:
      tags:
      - CloudSpecification
      summary: Get Telco Cloud Definition (TCD)
      description: Get Telco Cloud Definition (TCD)
      operationId: getCloudSpec
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudSpec'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
    put:
      tags:
      - CloudSpecification
      summary: Create/Update Telco Cloud Definition (TCD)
      description: Create/Update Telco Cloud Definition (TCD)
      operationId: modifySpec
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudSpec'
        required: true
      responses:
        "200":
          description: Successfully submitted Telco Cloud Definition (TCD).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
    post:
      tags:
      - CloudSpecification
      summary: Create Telco Cloud Definition (TCD)
      description: Create Telco Cloud Definition (TCD)
      operationId: createSpec
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudSpec'
        required: true
      responses:
        "200":
          description: Successfully submitted Telco Cloud Definition (TCD).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/scheme1/template:
    get:
      tags:
      - CloudSpecification
      summary: Get Cloud Specification Template
      description: Get Cloud Specification Template
      operationId: getCloudSpecTemplate
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudSpec'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/hosts:
    put:
      tags:
      - Hosts
      summary: Edit hosts
      description: Add hosts
      operationId: editHosts
      parameters:
      - name: apiKey
        in: header
        description: api key header parameter
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostsAddRequest'
        required: true
      responses:
        "200":
          description: Successfully added host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
      security:
      - ApiKeyAuth: []
    post:
      tags:
      - Hosts
      summary: Add hosts
      description: Add hosts
      operationId: addHosts
      parameters:
      - name: apiKey
        in: header
        description: api key header parameter
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostsAddRequest'
        required: true
      responses:
        "200":
          description: Successfully added host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
      security:
      - ApiKeyAuth: []
  /ztp/domains/{domain_name}/deletehosts:
    post:
      tags:
      - Hosts
      summary: Delete hosts
      description: Delete hosts
      operationId: deleteHosts
      parameters:
      - name: domain_name
        in: path
        description: Domain Name
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostsDeleteRequest'
        required: true
      responses:
        "200":
          description: Successfully deleted host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/users:
    get:
      tags:
      - Users
      summary: Get Users
      description: Get Users
      operationId: getUsers
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usersResponse'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/metadata:
    get:
      tags:
      - Metadata
      summary: Get Metadata
      description: Get Metadata
      operationId: getMetadata
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/metadata'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/status:
    get:
      tags:
      - Status
      summary: Get Status
      description: Get Status
      operationId: getStatus
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configStatus'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/configure/maas:
    post:
      tags:
      - Dns Config
      summary: Update DNS Entries
      description: Update DNS Entries
      operationId: updateDns
      requestBody:
        description: DNS Config Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dnsConfig'
        required: true
      responses:
        "200":
          description: Successfully update dns configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/tasks:
    get:
      tags:
      - Tasks
      summary: Get Tasks
      description: Get Tasks
      operationId: getTasks
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tasksResponse'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/tasks/{taskId}:
    get:
      tags:
      - Task
      summary: Get A Task
      description: Get A Task
      operationId: getTaskById
      parameters:
      - name: taskId
        in: path
        description: Task ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/task'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/resync:
    post:
      tags:
      - Resync
      summary: Resync Domains
      description: Resync Domains
      operationId: resyncDomains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resyncRequest'
        required: true
      responses:
        "200":
          description: Request successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/security/signingAuthorities:
    get:
      tags:
      - certificateManagement
      summary: Get all Certificate Signing Authorities
      description: Get all Certificate Signing Authorities
      operationId: getSigningAuthorities
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/signingAuthoritiesResponse'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
    post:
      tags:
      - certificateManagement
      summary: Create Certificate Signing Authority
      description: "selfsign: TCF manager will host a root CA and it will be self-signed.\n\
        intermediate: TCF manager will host an intermediate CA and this CA's certificate\
        \ will be signed by some external CA.\n"
      operationId: createSigningAuthority
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/signingAuthority'
        required: true
      responses:
        "200":
          description: Request successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/security/signingAuthorities/{name}:
    get:
      tags:
      - certificateManagement
      summary: Get Certificate Signing Authorities of type
      description: Get Certificate Signing Authorities of type
      operationId: getSigningAuthority
      parameters:
      - name: name
        in: path
        description: name of signing authority
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/signingAuthority'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/domains/{domainName}/security/manage:
    post:
      tags:
      - certificateManagement
      summary: Certificate Management Input
      description: Certificate Management Input
      operationId: manageCertificates
      parameters:
      - name: domainName
        in: path
        description: Domain Name
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/manageCertificatesRequest'
        required: true
      responses:
        "200":
          description: Request successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/domains/{domainName}/security/retry:
    post:
      tags:
      - certificateManagement
      summary: Retry failed certificate management task/s
      description: Retry failed certificate management task/s
      operationId: retryFailedCertificateOperation
      parameters:
      - name: domainName
        in: path
        description: Domain Name
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/certRetryAppliances'
      responses:
        "200":
          description: Request successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/domains/{domainName}/security/csr:
    get:
      tags:
      - certificateManagement
      summary: Download CSR for appliances
      description: Download CSR for appliances
      operationId: downloadCsrs
      parameters:
      - name: domainName
        in: path
        description: Domain Name
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Request successfully serviced.
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/domains/{domainName}/security/certificates:
    post:
      tags:
      - certificateManagement
      summary: upload certificate to appliance
      operationId: uploadCertificates
      parameters:
      - name: domainName
        in: path
        description: Domain Name
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/security_certificates_body'
      responses:
        "200":
          description: Request successfully submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/domains/{domainName}/security/appliances:
    get:
      tags:
      - certificateManagement
      summary: Get Certificate Management Appliances
      description: Get Certificate Management Appliances
      operationId: getAppliances
      parameters:
      - name: domainName
        in: path
        description: domainName
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificateManagementAppliancesResponse'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
  /ztp/appliancesizes:
    get:
      summary: Get different Sizes of appliances like form factor
      description: Get appliance sizes
      operationId: getApplianceSizes
      responses:
        "200":
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appliancesFormFactors'
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
components:
  schemas:
    cloudSpec:
      type: object
      properties:
        domains:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/domain'
        settings:
          $ref: '#/components/schemas/settings'
        appliances:
          type: array
          items:
            $ref: '#/components/schemas/appliance'
        images:
          $ref: '#/components/schemas/images'
        _comments:
          type: array
          items:
            type: string
    hostsAddRequest:
      type: object
      properties:
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/hostConfig'
    hostsDeleteRequest:
      type: object
      properties:
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/hostDeleteConfig'
    usersResponse:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/user'
    metadata:
      type: object
      properties:
        domainTypes:
          type: array
          items:
            $ref: '#/components/schemas/metadata_domainTypes'
    domainType:
      type: string
      enum:
      - CENTRAL_SITE
      - REGIONAL_SITE
      - CELL_SITE_GROUP
      - COMPUTE_CLUSTER
    configStatus:
      type: object
      properties:
        domains:
          type: array
          items:
            $ref: '#/components/schemas/domainStatus'
        messages:
          type: array
          items:
            type: string
    dnsConfig:
      required:
      - consumerKey
      - maasAddress
      - tokenKey
      - tokenSecret
      type: object
      properties:
        consumerKey:
          type: string
        tokenKey:
          type: string
        tokenSecret:
          type: string
        maasAddress:
          type: string
    tasksResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/task'
      additionalProperties: false
    task:
      type: object
      properties:
        subTasks:
          type: array
          items:
            $ref: '#/components/schemas/task'
        name:
          type: string
        type:
          type: string
        taskId:
          type: string
        status:
          type: string
        startTime:
          type: integer
        endTime:
          type: integer
        progressInPercentage:
          type: integer
        statusMessage:
          type: string
    resyncRequest:
      type: object
      properties:
        domains:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/resyncRequest_domains'
    manageCertificatesRequest:
      required:
      - appliances
      - csrDetails
      - days
      type: object
      properties:
        appliances:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/manageCertificatesRequest_appliances'
        csrDetails:
          $ref: '#/components/schemas/csrDetails'
        caName:
          type: string
        days:
          type: integer
          default: 365
    certRetryAppliances:
      required:
      - appliances
      type: object
      properties:
        appliances:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/manageCertificatesRequest_appliances'
    signingAuthority:
      required:
      - csrDetails
      - name
      - type
      - validForDays
      type: object
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/caType'
        validForDays:
          type: integer
          default: 365
        csrDetails:
          $ref: '#/components/schemas/csrDetails'
    signingAuthoritiesResponse:
      type: object
      properties:
        authorities:
          type: array
          items:
            $ref: '#/components/schemas/signingAuthority'
    certificateManagementAppliancesResponse:
      type: object
      properties:
        appliances:
          type: array
          items:
            $ref: '#/components/schemas/certificateManagementAppliance'
    appliancesFormFactors:
      required:
      - appliances
      type: object
      properties:
        appliances:
          type: array
          items:
            $ref: '#/components/schemas/applianceFormFactor'
    response:
      type: object
      properties:
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/warning'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
    domain:
      required:
      - name
      - type
      type: object
      properties:
        name:
          pattern: "^[^\\s]+$"
          type: string
        type:
          $ref: '#/components/schemas/domainType'
        subType:
          $ref: '#/components/schemas/domainSubType'
        enabled:
          type: boolean
          default: true
        preDeployed:
          $ref: '#/components/schemas/preDeployed'
        minimumHosts:
          type: integer
        parent:
          pattern: "^[^\\s]+$"
          type: string
        location:
          $ref: '#/components/schemas/location'
        licenses:
          $ref: '#/components/schemas/licenses'
        switches:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/switch'
        services:
          minItems: 2
          type: array
          items:
            $ref: '#/components/schemas/service'
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
        applianceOverrides:
          type: array
          items:
            $ref: '#/components/schemas/applianceOverride'
        cellsiteGroups:
          type: array
          items:
            $ref: '#/components/schemas/cellsiteGroup'
        settings:
          $ref: '#/components/schemas/domainSettings'
    settings:
      required:
      - dnsServers
      - dnsSuffix
      type: object
      properties:
        saas:
          type: string
        dnsSuffix:
          pattern: "^[^\\s]+$"
          type: string
        ntpServers:
          minItems: 1
          type: array
          items:
            type: string
        dnsServers:
          minItems: 1
          type: array
          items:
            type: string
        applianceNamingScheme:
          type: string
          default: "{applianceName}-{domainName}"
        proxy:
          $ref: '#/components/schemas/proxyConfig'
        appliancesSharedWithManagementDomain:
          type: array
          items:
            $ref: '#/components/schemas/applianceSharedWithManagementDomain'
        _comments:
          type: array
          items:
            type: string
    appliance:
      required:
      - name
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/applianceType'
        id:
          type: string
        name:
          pattern: "^[^\\s]+$"
          type: string
        ipIndex:
          type: integer
        parent:
          pattern: "^[^\\s]+$"
          type: string
        rootPassword:
          type: string
        adminPassword:
          type: string
        auditPassword:
          type: string
        size:
          $ref: '#/components/schemas/applianceSize'
        tier0Mode:
          type: string
          enum:
          - ACTIVE_STANDBY
          - ACTIVE_ACTIVE
        ipIndexPool:
          type: array
          items:
            $ref: '#/components/schemas/ipIndexPool'
        nodeCount:
          type: integer
        enabled:
          type: boolean
        shares:
          type: array
          items:
            $ref: '#/components/schemas/share'
        _comments:
          type: array
          items:
            type: string
    images:
      required:
      - cloudbuilder
      - kube
      - tca
      - vro
      type: object
      properties:
        cloudbuilder:
          type: string
        vro:
          type: string
        tca:
          type: string
        haproxy:
          type: array
          items:
            type: string
        kube:
          minItems: 1
          type: array
          items:
            type: string
        vsphere_plugin:
          type: string
        vrli:
          type: string
    csrDetails:
      required:
      - algorithm
      - country
      - keySize
      type: object
      properties:
        country:
          type: string
        organization:
          type: string
        organizationUnit:
          type: string
        state:
          type: string
        keySize:
          type: integer
        algorithm:
          type: string
          enum:
          - RSA
          default: RSA
        emailAddress:
          type: string
        locality:
          type: string
    caType:
      type: string
      enum:
      - selfsign
      - intermediate
    hostConfig:
      required:
      - address
      - parent
      - password
      - type
      - username
      type: object
      properties:
        address:
          type: string
        ip:
          type: string
        name:
          type: string
        username:
          type: string
        password:
          type: string
        parent:
          pattern: "^[^\\s]+$"
          type: string
        type:
          $ref: '#/components/schemas/domainType'
        location:
          $ref: '#/components/schemas/location'
        wipeDisks:
          type: boolean
    hostDeleteConfig:
      required:
      - name
      type: object
      properties:
        name:
          type: string
        wipeDisks:
          type: boolean
    user:
      required:
      - username
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        apiKey:
          type: string
    domainStatus:
      required:
      - hosts
      - name
      - type
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        status:
          type: string
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/hostStatus'
        appliances:
          type: array
          items:
            $ref: '#/components/schemas/applianceStatus'
        messages:
          $ref: '#/components/schemas/response'
        taskId:
          type: string
        startTime:
          type: integer
        endTime:
          type: integer
        createdTimestamp:
          type: integer
        lastUpdatedTimestamp:
          type: integer
    certificateManagementAppliance:
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        status:
          type: string
        issuedOn:
          type: integer
        validUpto:
          type: integer
        issuer:
          type: string
        certificateStatus:
          type: string
    applianceFormFactor:
      required:
      - size
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/applianceType'
        size:
          $ref: '#/components/schemas/applianceSize'
        version:
          type: string
        cpuCount:
          type: integer
        memoryInGB:
          type: integer
        diskInGB:
          type: integer
        description:
          type: string
    warning:
      type: object
      properties:
        message:
          type: string
    error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    domainSubType:
      type: string
      enum:
      - MANAGEMENT
      - WORKLOAD
    preDeployed:
      required:
      - preDeployed
      type: object
      properties:
        preDeployed:
          type: boolean
          default: false
        defaultResources:
          $ref: '#/components/schemas/defaultResources'
    location:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        address:
          maximum: 1024
          type: string
        longitude:
          maximum: 180.0
          minimum: -180.0
          type: number
        latitude:
          maximum: 90.0
          minimum: -90.0
          type: number
    licenses:
      type: object
      properties:
        vc:
          minItems: 1
          type: array
          items:
            type: string
        nsx:
          minItems: 1
          type: array
          items:
            type: string
        esxi:
          minItems: 1
          type: array
          items:
            type: string
        vsan:
          minItems: 1
          type: array
          items:
            type: string
        tca:
          minItems: 1
          type: array
          items:
            type: string
        tca_cp:
          minItems: 1
          type: array
          items:
            type: string
        vrli:
          minItems: 1
          type: array
          items:
            type: string
    switch:
      required:
      - name
      - uplinks
      type: object
      properties:
        name:
          type: string
        uplinks:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/switch_uplink'
    service:
      required:
      - enabled
      - name
      - type
      type: object
      properties:
        name:
          $ref: '#/components/schemas/serviceName'
        type:
          $ref: '#/components/schemas/serviceType'
        enabled:
          type: boolean
          default: true
        nsxConfig:
          $ref: '#/components/schemas/nsxConfig'
    network:
      required:
      - mtu
      - name
      - segmentType
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - management
          - vMotion
          - vSAN
          - nsxHostOverlay
          - nsxEdgeOverlay
          - uplink
          - application
        name:
          type: string
        segmentType:
          type: string
          enum:
          - vlan
          - overlay
          default: vlan
        switch:
          type: string
        vlan:
          type: integer
        mtu:
          type: integer
        gateway:
          type: string
        prefixLength:
          maximum: 32
          minimum: 0
          type: integer
        ipAddresses:
          type: array
          items:
            type: string
        ipPool:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ipPool'
        dhcpConfig:
          $ref: '#/components/schemas/dhcpConfig'
        _comments:
          type: array
          items:
            type: string
    applianceOverride:
      required:
      - name
      type: object
      properties:
        name:
          pattern: "^[^\\s]+$"
          type: string
        size:
          $ref: '#/components/schemas/applianceSize'
        enabled:
          type: boolean
        id:
          type: string
        nameOverride:
          pattern: "^[^\\s]+$"
          type: string
        tier0Mode:
          type: string
          enum:
          - ACTIVE_STANDBY
          - ACTIVE_ACTIVE
        parent:
          pattern: "^[^\\s]+$"
          type: string
        type:
          $ref: '#/components/schemas/applianceType'
        rootPassword:
          type: string
        adminPassword:
          type: string
        auditPassword:
          type: string
        ipIndex:
          type: integer
        ipIndexPool:
          type: array
          items:
            $ref: '#/components/schemas/ipIndexPool'
        nodeCount:
          type: integer
        shares:
          type: array
          items:
            $ref: '#/components/schemas/share'
        _comments:
          type: array
          items:
            type: string
    cellsiteGroup:
      required:
      - name
      - switches
      type: object
      properties:
        name:
          pattern: "^[^\\s]+$"
          type: string
        switches:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/switch'
        networks:
          type: array
          items:
            $ref: '#/components/schemas/network'
    domainSettings:
      type: object
      properties:
        dnsSuffix:
          pattern: "^[^\\s]+$"
          type: string
        ntpServers:
          minItems: 1
          type: array
          items:
            type: string
        dnsServers:
          minItems: 1
          type: array
          items:
            type: string
        applianceNamingScheme:
          type: string
        appliancesSharedWithManagementDomain:
          type: array
          items:
            $ref: '#/components/schemas/applianceSharedWithManagementDomain'
        proxy:
          $ref: '#/components/schemas/proxyConfig'
        _comments:
          type: array
          items:
            type: string
    proxyConfig:
      type: object
      properties:
        server:
          type: string
        protocol:
          type: string
        port:
          type: integer
        username:
          type: string
        password:
          type: string
        enabled:
          type: boolean
          default: true
        exclusions:
          type: array
          items:
            type: string
    applianceSharedWithManagementDomain:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/applianceType'
        enabled:
          type: boolean
          default: false
    applianceType:
      type: string
      enum:
      - VC
      - SDDC_MANAGER
      - CLOUD_BUILDER
      - VRO
      - VRLI
      - NSX_MANAGER
      - NSX_MANAGER_NODE
      - NSX_EDGE_CLUSTER
      - NSX_EDGE
      - TCA_CP
      - TCA
      - VSAN_NFS
    applianceSize:
      type: string
      enum:
      - tiny
      - small
      - medium
      - large
      - xlarge
    ipIndexPool:
      required:
      - end
      - start
      type: object
      properties:
        start:
          type: integer
        end:
          type: integer
    share:
      required:
      - name
      - quotaInMb
      type: object
      properties:
        name:
          type: string
        quotaInMb:
          minimum: 1
          type: integer
    hostStatus:
      required:
      - ip
      - name
      - parent
      - status
      - type
      - username
      type: object
      properties:
        ip:
          type: string
        name:
          type: string
        username:
          type: string
        type:
          type: string
        parent:
          type: string
        status:
          type: string
        registrationUser:
          type: string
        lastUpdatedByUser:
          type: string
        registrationTimestamp:
          type: integer
        lastUpdatedTimestamp:
          type: integer
        bootstrap_host:
          type: boolean
        location:
          $ref: '#/components/schemas/location'
    applianceStatus:
      type: object
      properties:
        name:
          type: string
        ip:
          type: string
        status:
          type: string
        type:
          type: string
        serviceUrl:
          type: string
    defaultResources:
      type: object
      properties:
        datacenter:
          type: string
        cluster:
          type: string
        datastore:
          type: string
    switch_uplink:
      required:
      - pnic
      type: object
      properties:
        pnic:
          type: string
    serviceName:
      type: string
      enum:
      - networking
      - storage
    serviceType:
      type: string
      enum:
      - nsx
      - vsan
      - localstore
    nsxConfig:
      type: object
      properties:
        shareTransportZonesWithParent:
          type: boolean
          default: false
    ipPool:
      required:
      - end
      - start
      type: object
      properties:
        start:
          type: string
        end:
          type: string
    dhcpConfig:
      required:
      - ranges
      - serverAddress
      type: object
      properties:
        ranges:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ipPool'
        serverAddress:
          type: string
    security_certificates_body:
      type: object
      properties:
        fileName:
          type: string
          format: binary
    metadata_domainTypes:
      type: object
      properties:
        type:
          type: string
          enum:
          - CENTRAL_SITE
          - REGIONAL_SITE
          - CELL_SITE_GROUP
          - COMPUTE_CLUSTER
    resyncRequest_domains:
      required:
      - name
      type: object
      properties:
        name:
          pattern: "^[^\\s]+$"
          type: string
    manageCertificatesRequest_appliances:
      type: object
      properties:
        name:
          type: string
  responses:
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/response'
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/response'
  securitySchemes:
    x-hm-authorization:
      type: apiKey
      description: Obtained from /hybridity/api/session
      name: x-hm-authorization
      in: header