{
"additionalProperties": false,
"description": "External inspection profile is used when the TLS connection is destined to a service not owned by the enterprise.",
"extends": {
"$ref": "TlsProfile
},
"id": "TlsInspectionExternalProfile",
"module_id": "PolicyTlsActionProfile",
"polymorphic-type-descriptor": {
"type-identifier": "TlsInspectionExternalProfile"
},
"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"
},
"attention": {
"description": "Used to indicate an TLS version or Cipher version pre-defined settings mis-match.",
"readonly": true,
"required": false,
"title": "TLS Pre-defined settings mis-match",
"type": "string"
},
"children": {
"description": "subtree for this type within policy tree containing nested elements.",
"items": {
"$ref": "ChildPolicyConfigResource
},
"required": false,
"title": "subtree for this type within policy tree",
"type": "array"
},
"client_cipher_suite": {
"default": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
"TLS_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256",
"TLS_RSA_WITH_AES_256_GCM_SHA384",
"TLS_RSA_WITH_AES_256_CBC_SHA256"
],
"description": "Client's list of cipher suites. Required if CryptoEnforcement is ENFORCE. e.g. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.",
"items": {
"$ref": "TlsCiphers
},
"maxItems": 128,
"required": false,
"title": "List of cipher suites client supports",
"type": "array"
},
"client_max_tls_version": {
"$ref": "TlsProtocol,
"default": "TLS_V1_2",
"description": "Client's maximum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported TLS versions are TLS1.1 and TLS1.2.",
"required": false,
"title": "Maximum TLS version client supports"
},
"client_min_tls_version": {
"$ref": "TlsProtocol,
"default": "TLS_V1_1",
"description": "Client's minimum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported TLS versions are TLS1.1 and TLS1.2.",
"required": false,
"title": "Minimum TLS version client supports"
},
"crls": {
"default": [
"/infra/crls/default_public_crl"
],
"description": "Bypass profile - CRL is required if the \"invalid_certificate\" action is allow. External profile - CRL is always required. Internal profile - CRL is required if \"certificate_validation\" is turned on.",
"items": {
"type": "string"
},
"maxItems": 100,
"required": false,
"title": "Certificate Revocation List Ids",
"type": "array"
},
"crypto_enforcement": {
"$ref": "CryptoEnforcement,
"default": "ENFORCE",
"required": false
},
"decryption_fail_action": {
"$ref": "DecryptionFailAction,
"default": "BYPASS",
"required": false
},
"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"
},
"idle_connection_timeout": {
"default": 5400,
"description": "Timeout the connection when kept idle. Default is 90 minutes.",
"maximum": 4320000,
"minimum": 1,
"required": false,
"title": "Idle connection timeout in seconds",
"type": "int"
},
"invalid_cert_action": {
"$ref": "InvalidCertificateAction,
"default": "ALLOW",
"required": false
},
"marked_for_delete": {
"default": false,
"description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"ocsp_must_staple": {
"default": false,
"description": "true - enable the ocsp must staple, false - disable it.",
"required": false,
"title": "Flag to enable/disable ocsp must staple",
"type": "boolean"
},
"overridden": {
"default": false,
"description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"proxy_trusted_ca_cert": {
"description": "Proxy trusted ca cert and key used to issue valid ca certificate. This is the subordinate CA cert (referred to as Proxy CA) by the Enterprise Issuing CA.",
"required": true,
"title": "Proxy trusted ca cert and key",
"type": "string"
},
"proxy_untrusted_ca_cert": {
"description": "Proxy untrusted ca cert and key used to issue invalid ca certificate",
"required": true,
"title": "Proxy untrusted ca cert and key",
"type": "string"
},
"realization_id": {
"description": "This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated thier unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for realizing intent",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"resource_type": {
"description": "Resource type to use as profile type",
"enum": [
"TlsInspectionBypassProfile",
"TlsInspectionExternalProfile",
"TlsInspectionInternalProfile"
],
"help_summary": "Possible values are\n'TlsInspectionExternalProfile',\n'TlsInspectionInternalProfile'\n",
"required": true,
"title": "Resource type to use as profile type.",
"type": "string"
},
"server_cipher_suite": {
"default": [
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
"TLS_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256",
"TLS_RSA_WITH_AES_256_GCM_SHA384",
"TLS_RSA_WITH_AES_256_CBC_SHA256"
],
"description": "Server's list of cipher suites. Required if CryptoEnforcement is ENFORCE. e.g. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.",
"items": {
"$ref": "TlsCiphers
},
"maxItems": 128,
"required": false,
"title": "List of cipher suites server support",
"type": "array"
},
"server_max_tls_version": {
"$ref": "TlsProtocol,
"default": "TLS_V1_2",
"description": "Server's maximum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported versions are TLS1.1 and TLS1.2.",
"required": false,
"title": "Maximum TLS version server supports"
},
"server_min_tls_version": {
"$ref": "TlsProtocol,
"default": "TLS_V1_1",
"description": "Server's minimum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported versions are TLS1.1 and TLS1.2.",
"required": false,
"title": "Minimum TLS version server supports"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"tls_config_setting": {
"$ref": "TlsConfigSettings,
"default": "BALANCED",
"required": false
},
"trusted_ca_bundles": {
"default": [
"/infra/cabundles/default_trusted_public_ca_bundle"
],
"description": "Bypass profile - CA bundle is required if the \"invalid_certificate\" action is allow. External profile - CA bundle is always required. Internal profile - CA bundle is required if \"certificate_validation\" is turned on.",
"items": {
"type": "string"
},
"maxItems": 100,
"required": false,
"title": "List of CA bundle Ids",
"type": "array"
},
"unique_id": {
"description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"title": "TLS inspection external profile",
"type": "object"
}