NSX-T Data Center REST API

VodapGlobalCollector (type)

{
  "additionalProperties": false,
  "description": "VODAP collector is defined to export metrics to VCF-OPS for monitoring and streaming analysis.",
  "extends": {
    "$ref": "GlobalCollectorConfig"
  },
  "id": "VodapGlobalCollector",
  "module_id": "Policy",
  "nsx_feature": "VODAPStreaming",
  "polymorphic-type-descriptor": {
    "type-identifier": "VODAP_STREAMING"
  },
  "properties": {
    "client_id": {
      "description": "Client ID which is used to request token from vIDB.",
      "required": true,
      "title": "Client ID",
      "type": "string"
    },
    "client_secret": {
      "description": "Client secret which is used to request token from vIDB.",
      "required": true,
      "sensitive": true,
      "title": "Client secret",
      "type": "secure_string"
    },
    "collector_fqdn": {
      "description": "FQDN for the global collector. Only VODAP_STREAMING collector config use this. Either FQDN or IP must be provided for a VODAP_STREAMING collector but not both or neither.",
      "nsx_feature": "VODAPStreaming",
      "required": false,
      "title": "FQDN for the global collector",
      "type": "string"
    },
    "collector_ip": {
      "$ref": "IPAddress",
      "deprecated": true,
      "description": "This property is deprecated and only should be used for VRNI, WAVE_FRONT and VRNI_STREAMING. Please use collector_fqdn for VODAP_STREAMING. IP address for the global collector. It must be provided in VRNI, WAVE_FRONT and VRNI_STREAMING collector config.",
      "required": false,
      "title": "IP address for the global collector"
    },
    "collector_port": {
      "description": "Port for the global collector.",
      "maximum": 65535,
      "minimum": 1,
      "required": true,
      "title": "Port for the global collector",
      "type": "int"
    },
    "collector_type": {
      "$ref": "GlobalCollectorType",
      "description": "Specify the global collector type.",
      "required": true
    },
    "root_certificate": {
      "description": "Root certificate which is used to verify certificate of VODAP.",
      "required": true,
      "title": "Root certificate for VODAP",
      "type": "string"
    },
    "tenant_name": {
      "default": "",
      "description": "Tenant name which is used to request token from vIDB.",
      "required": false,
      "title": "Tenant name",
      "type": "string"
    },
    "vidb_certificate": {
      "description": "Root certificate which is used to verify certificate of vIDB.",
      "required": true,
      "title": "Root certificate for vIDB",
      "type": "string"
    },
    "vidb_fqdn": {
      "description": "FQDN of vIDB for client to get token.",
      "required": true,
      "title": "FQDN of vIDB",
      "type": "string"
    }
  },
  "title": "NSX global configs for VODAP global collector",
  "type": "object"
}