| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
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.
|
string |
Readonly |
| _revision |
Generation of this resource config
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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| attention |
TLS Pre-defined settings mis-match
Used to indicate an TLS version or Cipher version pre-defined settings mis-match.
|
string |
Readonly |
| certificate_validation |
Flag to enable/disable certificate validation
true - enable the certificate validation; false - disable it. |
boolean |
Default: "False" |
| children |
subtree for this type within policy tree
subtree for this type within policy tree containing nested elements.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| client_cipher_suite |
List of cipher suites client supports
Client's list of cipher suites. Required if CryptoEnforcement
is ENFORCE. e.g. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
|
array of TlsCiphers |
Maximum items: 128
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']" |
| client_max_tls_version |
Maximum TLS version client supports
Client's maximum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported versions are TLS1.1 and TLS1.2. |
TlsProtocol |
Default: "TLS_V1_2" |
| client_min_tls_version |
Minimum TLS version client supports
Client's minimum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported versions are TLS1.1 and TLS1.2. |
TlsProtocol |
Default: "TLS_V1_1" |
| crls |
Certificate Revocation List Ids
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.
|
array of string |
Maximum items: 100
Default: "['/infra/crls/default_public_crl']" |
| crypto_enforcement |
|
CryptoEnforcement |
Default: "ENFORCE" |
| decryption_fail_action |
|
DecryptionFailAction |
Default: "BYPASS" |
| default_cert_key |
One of the actual server certificate presented to the client
Default server certificate presented to the user. |
string |
|
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| id |
Unique identifier of this resource |
string |
Sortable |
| idle_connection_timeout |
Idle connection timeout in seconds
Timeout the connection when kept idle. Default is 90 minutes. |
int |
Minimum: 1
Maximum: 4320000
Default: "5400" |
| marked_for_delete |
Indicates whether the intent object is marked for deletion
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.
|
boolean |
Readonly
Default: "False" |
| ocsp_must_staple |
Flag to enable/disable ocsp must staple
true - enable the ocsp must staple, false - disable it. |
boolean |
Default: "False" |
| overridden |
Indicates whether this object is the overridden intent object
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.
|
boolean |
Readonly
Default: "False" |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| realization_id |
A unique identifier assigned by the system for realizing intent
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.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value TlsInspectionInternalProfile |
string |
Required
Enum: TlsInspectionBypassProfile, TlsInspectionExternalProfile, TlsInspectionInternalProfile |
| server_certs_key |
Actual server certificate key
Server certificate presented to the client. |
array of string |
Required
Maximum items: 100 |
| server_cipher_suite |
List of cipher suites server support
Server's list of cipher suites. Required if CryptoEnforcement
is ENFORCE. e.g. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
|
array of TlsCiphers |
Maximum items: 128
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']" |
| server_max_tls_version |
Maximum TLS version server supports
Server's maximum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. Supported versions are TLS1.0, TLS1.1 and TLS1.2 |
TlsProtocol |
Default: "TLS_V1_2" |
| server_min_tls_version |
Minimum TLS version server supports
Server's minimum TLS version to enforce. Required if CryptoEnforcement is ENFORCE. supported versions are TLS1.1 and TLS1.2. |
TlsProtocol |
Default: "TLS_V1_1" |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| tls_config_setting |
|
TlsConfigSettings |
Default: "BALANCED" |
| trusted_ca_bundles |
List of CA bundle Ids
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.
|
array of string |
Maximum items: 100
Default: "['/infra/cabundles/default_trusted_public_ca_bundle']" |
| unique_id |
A unique identifier assigned by the system
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.
|
string |
Readonly |