{
"additionalProperties": false,
"description": "Intrusion Detection System Signature .",
"extends": {
"$ref": "PolicyConfigResource
},
"id": "IdsSignature",
"module_id": "PolicyIDSMetrics",
"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"
},
"action": {
"description": "Signature action.",
"required": false,
"title": "Represents the signature's action",
"type": "string"
},
"attack_target": {
"description": "Target of the signature.",
"required": false,
"title": "Signature attack target",
"type": "string"
},
"categories": {
"description": "Represents the internal categories a signature belongs to.",
"items": {
"$ref": "IdsSignatureInternalCategory
},
"required": false,
"title": "IDS Signature Internal category",
"type": "array"
},
"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"
},
"class_type": {
"description": "Class type of Signature.",
"required": false,
"title": "Signature class type",
"type": "string"
},
"confidence": {
"description": "Signature's confidence score.",
"title": "Confidence",
"type": "string"
},
"cves": {
"description": "CVE score",
"items": {
"type": "string"
},
"required": false,
"title": "Represents the cve score.",
"type": "array"
},
"cvss": {
"description": "Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. NONE means cvssv3/cvssv2 score as 0.0 LOW means cvssv3/cvssv2 score as 0.1-3.9 MEDIUM means cvssv3/cvssv2 score as 4.0-6.9 HIGH means cvssv3/cvssv2 score as 7.0-8.9 CRITICAL means cvssv3/cvssv2 score as 9.0-10.0",
"enum": [
"NONE",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"required": false,
"title": "CVSS of signature",
"type": "string"
},
"cvss_score": {
"description": "Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. If cvssv3 exists, then this is the cvssv3 score, else it is the cvssv2 score.",
"required": false,
"title": "Signature CVSS score",
"type": "string"
},
"cvssv2": {
"description": "Signature cvssv2 score.",
"required": false,
"title": "Signature cvssv2 score",
"type": "string"
},
"cvssv3": {
"description": "Signature cvssv3 score.",
"required": false,
"title": "Signature cvssv3 score",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"direction": {
"description": "Source-destination direction.",
"title": "Direction",
"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"
},
"enable": {
"description": "Flag which tells whether the signature is enabled or not.",
"required": false,
"title": "Enable/Disable flag",
"type": "boolean"
},
"flow": {
"description": "Flow established from server, from client etc.",
"required": false,
"title": "Flow established.",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"impact": {
"description": "Impact of Signature.",
"title": "Impact",
"type": "string"
},
"malware_family": {
"description": "Family of the malware tracked in the signature.",
"title": "Malware Family",
"type": "string"
},
"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"
},
"mitre_attack": {
"description": "Mitre Attack details of Signature.",
"items": {
"$ref": "MitreAttack
},
"title": "MitreAttack",
"type": "array"
},
"name": {
"description": "Signature name.",
"required": false,
"title": "Represents the signature name",
"type": "string"
},
"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"
},
"performance_impact": {
"description": "Performance impact of the signature.",
"title": "Performance impact",
"type": "string"
},
"policy": {
"description": "Signature policy.",
"items": {
"type": "string"
},
"title": "Policy",
"type": "array"
},
"product_affected": {
"description": "Product affected by this signature.",
"required": false,
"title": "Signature product affected",
"type": "string"
},
"protocol": {
"description": "Protocol used in the packet analysis.",
"title": "Protocol",
"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": "The type of this resource.",
"readonly": false,
"type": "string"
},
"risk_score": {
"description": "Risk score of signature.",
"title": "Risk Score",
"type": "string"
},
"severity": {
"description": "Represents the severity of the Signature.",
"required": false,
"title": "Signature severity",
"type": "string"
},
"signature_id": {
"description": "Represents the Signature's id.",
"required": false,
"title": "Signature ID",
"type": "string"
},
"signature_revision": {
"description": "Represents revision of the Signature.",
"required": false,
"title": "Signature revision",
"type": "string"
},
"signature_severity": {
"description": "Signature vendor set severity of the signature rule.",
"title": "Signature severity",
"type": "string"
},
"tag": {
"description": "Vendor assigned classification tag.",
"items": {
"type": "string"
},
"title": "Signature tag",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"type": {
"description": "Signature type.",
"items": {
"type": "string"
},
"title": "Type",
"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"
},
"urls": {
"description": "List of mitre attack URLs pertaining to signature",
"items": {
"type": "string"
},
"required": false,
"title": "List of mitre attack URLs pertaining to signature.",
"type": "array"
}
},
"title": "Intrusion Detection System Signature",
"type": "object"
}