NSX-T Data Center Global Manager REST API

CertificateProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "CertificateProfile", 
  "module_id": "CertificateManager", 
  "properties": {
    "_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"
    }, 
    "abort_on_error": {
      "description": "If this field is true, the certificate batch operation would be aborted if an error occurs during the replacement operation for this certificate profile.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Abort when there's an error", 
      "type": "boolean"
    }, 
    "affected_services": {
      "description": "A comma-separated list of service names that may be affected/interrupted when replacing the certificate for this service-type.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Affected Services", 
      "type": "string"
    }, 
    "certificate_class": {
      "$ref": "CertificateClass, 
      "description": "Service-types that are in a 'class'' cannot be share a certificate with a service in another 'class'.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Category"
    }, 
    "cluster_certificate": {
      "description": "True if this is for a cluster certificate", 
      "readonly": true, 
      "required": true, 
      "title": "Cluster Certificate", 
      "type": "boolean"
    }, 
    "deprecated_in_version": {
      "description": "Version in which this certificate profile was deprecated.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Deprecated in version", 
      "type": "string"
    }, 
    "description": {
      "description": "A longer description what the service-type is used for.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "extended_key_usage": {
      "description": "Indicating whether this certificate is used for server-auth, client-auth or both.", 
      "items": {
        "$ref": "CertificateUsageType
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Extended Key Usage", 
      "type": "array"
    }, 
    "node_type": {
      "description": "List of types of node this certificate applies to.", 
      "items": {
        "$ref": "NodeType
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Node Type", 
      "type": "array"
    }, 
    "processing_order": {
      "description": "The order in which service-type certificates are replaced in a batch-replace.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Processing Order", 
      "type": "integer"
    }, 
    "profile_name": {
      "readonly": true, 
      "required": true, 
      "title": "Certificate Profile Name", 
      "type": "string"
    }, 
    "replacement_duration": {
      "description": "The estimated amount of time it takes to replace the certificate for this service-type, in seconds.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Processing Duration", 
      "type": "integer"
    }, 
    "requires_private_key": {
      "description": "True if this certificate needs a private key.", 
      "readonly": true, 
      "required": true, 
      "title": "Requires Private Key", 
      "type": "boolean"
    }, 
    "service_type": {
      "$ref": "ServiceType, 
      "description": "A short and unique name for the type of service this certificate is used for.", 
      "readonly": true, 
      "required": true, 
      "title": "Unique Service Type"
    }, 
    "summary": {
      "description": "A short phrase what this service-type is for.", 
      "nsx_feature": "CertificateBatchOperations", 
      "readonly": true, 
      "required": false, 
      "title": "Summary", 
      "type": "string"
    }, 
    "unique_use": {
      "description": "True if the certificate used for this service-type cannot be used anywhere else.", 
      "readonly": true, 
      "required": true, 
      "title": "Unique Use", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}