NSX-T Data Center REST API

ComputeCollection (type)

{
  "additionalProperties": false,
  "description": "Represents a compute collection discovered from a registered Compute Manager (e.g., a vCenter cluster or resource pool).",
  "extends": {
    "$ref": "DiscoveredResource"
  },
  "id": "ComputeCollection",
  "module_id": "InventoryCmObj",
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of last modification",
      "readonly": true
    },
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "cm_local_id": {
      "readonly": true,
      "required": true,
      "title": "Local Id of the compute collection in the Compute Manager",
      "type": "string"
    },
    "datacenter_external_id": {
      "nsx_feature": "VpcTgwSpan",
      "readonly": true,
      "required": false,
      "title": "Datacenter external id of the compute collection in the Compute Manager",
      "type": "string"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "dpu_config": {
      "$ref": "ClusterDpuConfig",
      "description": "Specifies property related to cluster homogeneity for SmartNic",
      "readonly": true,
      "required": false,
      "title": "Configuration of homogeneous cluster"
    },
    "external_id": {
      "readonly": true,
      "required": true,
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n",
      "type": "string"
    },
    "host_groups": {
      "description": "List of host groups for a cluster",
      "items": {
        "$ref": "ClusterHostGroup"
      },
      "readonly": true,
      "required": false,
      "title": "Host groups",
      "type": "array"
    },
    "origin_id": {
      "readonly": true,
      "required": true,
      "title": "Id of the compute manager from where this Compute Collection was discovered",
      "type": "string"
    },
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair"
      },
      "readonly": true,
      "required": false,
      "title": "Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n",
      "type": "array"
    },
    "origin_type": {
      "description": "Identifies the type of compute collection as reported by the Compute Manager. VC_Cluster represents a vSphere cluster. VC_ResourcePool represents a vSphere resource pool. The \"VC_\" prefix denotes that the collection originates from a vCenter Compute Manager.",
      "readonly": true,
      "required": true,
      "title": "Origin Type of the Compute Collection",
      "type": "string"
    },
    "owner_id": {
      "readonly": true,
      "required": false,
      "title": "Id of the owner of compute collection in the Compute Manager",
      "type": "string"
    },
    "owner_nsx": {
      "description": "Identifies which NSX instance has prepared this Compute Collection. SELF - this NSX instance has prepared the Compute Collection. OTHER - another NSX instance has prepared the Compute Collection. MULTIPLE - multiple NSX instances attempted to prepare this Compute Collection simultaneously. NONE - no NSX instance has prepared this Compute Collection.",
      "enum": [
        "SELF",
        "OTHER",
        "MULTIPLE",
        "NONE"
      ],
      "readonly": true,
      "required": false,
      "title": "NSX ownership of the Compute Collection",
      "type": "string"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "required": true,
      "type": "string"
    },
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.",
      "items": {
        "$ref": "DiscoveredResourceScope"
      },
      "readonly": false,
      "required": false,
      "title": "List of scopes for discovered resource",
      "type": "array"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    }
  },
  "title": "Compute Collection",
  "type": "object"
}