NSX-T Data Center REST API

TelemetryConfig (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "TelemetryConfig", 
  "module_id": "TelemetryConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_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"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "ceip_acceptance": {
      "description": "Enable this flag to participate in the Customer Experience Improvement Program.", 
      "required": true, 
      "title": "Flag to indicate if CEIP has been accepted", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "proxy_enabled": {
      "default": false, 
      "description": "Enable this flag to specify a proxy, and provide the proxy settings.", 
      "required": false, 
      "title": "Flag to indicate if proxy has been configured", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "schedule_enabled": {
      "description": "Enable this to schedule data collection and upload times. If enabled, and a schedule is not provided, a default schedule (WEEKLY, Sunday at 2:00 a.m) will be applied.", 
      "required": true, 
      "title": "Flag to indicate if data collection is enabled", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "telemetry_deployment_id": {
      "description": "Deployment id generated during initialization of telemetry config.", 
      "readonly": true, 
      "required": false, 
      "title": "Deployment id associated with telemetry data", 
      "type": "string"
    }, 
    "telemetry_proxy": {
      "$ref": "TelemetryProxy, 
      "description": "Specify the proxy configuration (scheme, server, port) here.", 
      "required": false, 
      "title": "Set config for proxy to be used to send out telemetry data"
    }, 
    "telemetry_schedule": {
      "$ref": "TelemetrySchedule, 
      "description": "Specify one of Daily, Weekly or Monthly schedules.", 
      "required": false, 
      "title": "Set schedule for when telemetry data should be collected"
    }
  }, 
  "type": "object"
}